ElggAccessCollection.php

Go to the documentation of this file.

<?php

use Elgg\Exceptions\RuntimeException as ElggRuntimeException;

class ElggAccessCollection extends ElggData {

    public function __construct(stdClass $row = null) {
        $this->initializeAttributes();

        foreach ((array) $row as $key => $value) {
            $this->attributes[$key] = $value;
        }
    }

    protected function initializeAttributes() {
        parent::initializeAttributes();

        $this->attributes['id'] = null;
        $this->attributes['owner_guid'] = null;
        $this->attributes['name'] = null;
        $this->attributes['subtype'] = null;
    }

    public function __set($name, $value) {
        if (in_array($name, ['id', 'owner_guid', 'subtype'])) {
            throw new ElggRuntimeException("$name can not be set at runtime");
        }
        $this->attributes[$name] = $value;
    }

    public function __get($name) {
        if (array_key_exists($name, $this->attributes)) {
            return $this->attributes[$name];
        }

        return null;
    }

    public function getOwnerEntity() {
        return _elgg_services()->entityTable->get($this->owner_guid);
    }

    public function getDisplayName() {

        $filter = function($name = null) {
            if (!isset($name)) {
                $name = _elgg_services()->translator->translate('access:limited:label');
            }
            $params = [
                'access_collection' => $this,
            ];
            return (string) _elgg_services()->hooks->trigger('access_collection:name', $this->getType(), $params, $name);
        };

        $user = _elgg_services()->session->getLoggedInUser();
        $owner = $this->getOwnerEntity();
        if (!$user || !$owner) {
            // User is not logged in or does not access to the owner entity:
            // return default 'Limited' label
            return $filter();
        }
        
        if ($user->isAdmin() || $owner->guid == $user->guid) {
            return $filter($this->name);
        }

        return $filter();
    }

    public function save() : bool {
        if ($this->id > 0) {
            return _elgg_services()->accessCollections->rename($this->id, $this->name);
        } else {
            return (bool) _elgg_services()->accessCollections->create($this->name, $this->owner_guid);
        }
    }

    public function delete() {
        return _elgg_services()->accessCollections->delete($this->id);
    }

    public function canEdit($user_guid = null) {
        return _elgg_services()->accessCollections->canEdit($this->id, (int) $user_guid);
    }

    public function getMembers(array $options = []) {
        return _elgg_services()->accessCollections->getMembers($this->id, $options);
    }

    public function hasMember($member_guid = 0) {
        return _elgg_services()->accessCollections->hasUser($member_guid, $this->id);
    }

    public function addMember($member_guid = 0) {
        return _elgg_services()->accessCollections->addUser($member_guid, $this->id);
    }

    public function removeMember($member_guid = 0) {
        return _elgg_services()->accessCollections->removeUser($member_guid, $this->id);
    }

    public function getURL() {
        $type = $this->getType();
        $params = [
            'access_collection' => $this,
        ];
        $url = _elgg_services()->hooks->trigger('access_collection:url', $type, $params);
        return elgg_normalize_url($url);
    }

    public function toObject(array $params = []) {
        $object = new \Elgg\Export\AccessCollection();
        $object->type = $this->getType();
        $object->subtype = $this->getSubtype();
        $object->id = $this->id;
        $object->owner_guid = $this->owner_guid;
        $object->name = $this->name;

        $params['access_collection'] = $this;

        return _elgg_services()->hooks->trigger('to:object', 'access_collection', $params, $object);
    }

    public function getSystemLogID() {
        return $this->id;
    }

    public function getObjectFromID($id) {
        return _elgg_services()->accessCollections->get($id);
    }

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

    public function getSubtype() {
        if (isset($this->subtype)) {
            return $this->subtype;
        }
        
        return $this->name;
    }

}