ElggGroup.php

Go to the documentation of this file.

<?php

use Elgg\Groups\Tool;
use Elgg\Traits\Entity\PluginSettings;

class ElggGroup extends \ElggEntity {

    const CONTENT_ACCESS_MODE_UNRESTRICTED = 'unrestricted';
    const CONTENT_ACCESS_MODE_MEMBERS_ONLY = 'members_only';

    use PluginSettings;
    
    protected function initializeAttributes() {
        parent::initializeAttributes();
        $this->attributes['subtype'] = 'group';
    }

    public function getType() {
        return 'group';
    }

    public function getMembers(array $options = []) {
        $options['relationship'] = 'member';
        $options['relationship_guid'] = $this->getGUID();
        $options['inverse_relationship'] = true;
        $options['type'] = 'user';

        return elgg_get_entities($options);
    }

    public function isPublicMembership() {
        return ($this->membership == ACCESS_PUBLIC);
    }

    public function getContentAccessMode() {
        $mode = $this->content_access_mode;

        if (!isset($mode)) {
            if ($this->isPublicMembership()) {
                $mode = self::CONTENT_ACCESS_MODE_UNRESTRICTED;
            } else {
                $mode = self::CONTENT_ACCESS_MODE_MEMBERS_ONLY;
            }
        }

        // only support two modes for now
        if ($mode === self::CONTENT_ACCESS_MODE_MEMBERS_ONLY) {
            return $mode;
        }
        return self::CONTENT_ACCESS_MODE_UNRESTRICTED;
    }

    public function setContentAccessMode($mode) {
        if (!$mode && $this->content_access_mode) {
            return;
        }

        // only support two modes for now
        if ($mode !== self::CONTENT_ACCESS_MODE_MEMBERS_ONLY) {
            $mode = self::CONTENT_ACCESS_MODE_UNRESTRICTED;
        }

        $this->content_access_mode = $mode;
    }

    public function isMember(\ElggUser $user = null) {
        if ($user === null) {
            $user = _elgg_services()->session->getLoggedInUser();
        }
        if (!$user instanceof \ElggUser) {
            return false;
        }

        $result = $user->hasRelationship($this->guid, 'member');

        $params = [
            'user' => $user,
            'group' => $this,
        ];
        return _elgg_services()->hooks->triggerDeprecated('is_member', 'group', $params, $result, "Hook 'is_member', 'group' has been deprecated. Use 'gatekeeper', 'all' hook instead.", '4.3');
    }

    public function join(\ElggUser $user, $params = []) {
        if (!$user->addRelationship($this->guid, 'member')) {
            return false;
        }
        
        $event_params = [
            'group' => $this,
            'user' => $user,
        ];
        
        if (is_array($params)) {
            $event_params = array_merge($params, $event_params);
        }
        
        _elgg_services()->events->trigger('join', 'group', $event_params);
        
        return true;
    }

    public function leave(\ElggUser $user) {
        // event needs to be triggered while user is still member of group to have access to group acl
        $params = [
            'group' => $this,
            'user' => $user,
        ];
        _elgg_services()->events->trigger('leave', 'group', $params);

        return $user->removeRelationship($this->guid, 'member');
    }

    protected function prepareObject(\Elgg\Export\Entity $object) {
        $object = parent::prepareObject($object);
        $object->name = $this->getDisplayName();
        $object->description = $this->description;
        unset($object->read_access);
        return $object;
    }
    
    public function isToolEnabled($name) {
        if (empty($name)) {
            return false;
        }

        $tool = $this->getTool($name);
        if (!$tool instanceof Tool) {
            return false;
        }

        $md_name = $tool->mapMetadataName();
        $setting = $this->$md_name;

        if (!isset($setting)) {
            return $tool->isEnabledByDefault();
        }

        return $setting == 'yes';
    }

    public function enableTool($name) {
        $tool = $this->getTool($name);
        if (!$tool instanceof Tool) {
            return false;
        }

        $md_name = $tool->mapMetadataName();
        $md_value = $tool->mapMetadataValue('yes');

        $this->$md_name = $md_value;

        return true;
    }
    
    public function disableTool($name) {
        $tool = $this->getTool($name);
        if (!$tool instanceof Tool) {
            return false;
        }

        $md_name = $tool->mapMetadataName();
        $md_value = $tool->mapMetadataValue('no');

        $this->$md_name = $md_value;

        return true;
    }

    protected function getTool($name) {
        return _elgg_services()->group_tools->group($this)->get($name);
    }

    public function canAccessContent(ElggUser $user = null) {
        if (!isset($user)) {
            $user = _elgg_services()->session->getLoggedInUser();
        }

        if ($this->getContentAccessMode() == self::CONTENT_ACCESS_MODE_MEMBERS_ONLY) {
            if (!$user) {
                return false;
            }

            return $this->isMember($user) || $user->isAdmin();
        }

        return true;
    }
}