AccessCollections.php

Go to the documentation of this file.

<?php

namespace Elgg\Traits\Entity;

use Elgg\Exceptions\InvalidArgumentException as ElggInvalidArgumentException;

trait AccessCollections {
    
    public function getOwnedAccessCollections(array $options = []): array {
        $options['owner_guid'] = $this->guid;
        return _elgg_services()->accessCollections->getEntityCollections($options);
    }
    
    public function getOwnedAccessCollection(string $subtype): ?\ElggAccessCollection {
        if ($subtype === '') {
            throw new ElggInvalidArgumentException(__METHOD__ . ' requires $subtype to be non empty');
        }
        
        $acls = $this->getOwnedAccessCollections([
            'subtype' => $subtype,
        ]);
        
        return elgg_extract(0, $acls);
    }
    
    public function deleteAccessCollectionMemberships() {
        if (!$this->guid) {
            return false;
        }
        
        if ($this->type !== 'user') {
            return true;
        }
        
        $ac = _elgg_services()->accessCollections;
        
        $collections = $ac->getCollectionsByMember($this->guid);
        if (empty($collections)) {
            return true;
        }
        
        $result = true;
        foreach ($collections as $collection) {
            $result &= $ac->removeUser($this->guid, $collection->id);
        }
        
        return $result;
    }
    
    public function deleteOwnedAccessCollections() {
        if (!$this->guid) {
            return false;
        }
        
        $collections = $this->getOwnedAccessCollections();
        if (empty($collections)) {
            return true;
        }
        
        $result = true;
        foreach ($collections as $collection) {
            $result = $result & $collection->delete();
        }
        
        return $result;
    }
}