access.php

Go to the documentation of this file.

<?php
function elgg_get_ignore_access(): bool {
    return _elgg_services()->session->getIgnoreAccess();
}

function get_access_array(int $user_guid = 0): array {
    return _elgg_services()->accessCollections->getAccessArray($user_guid);
}

function get_default_access(ElggUser $user = null, array $input_params = []): int {
    // site default access
    $default_access = _elgg_services()->config->default_access;

    // user default access if enabled
    if (_elgg_services()->config->allow_user_default_access) {
        $user = $user ? $user : _elgg_services()->session->getLoggedInUser();
        if ($user) {
            $user_access = $user->getPrivateSetting('elgg_default_access');
            if ($user_access !== null) {
                $default_access = $user_access;
            }
        }
    }

    $params = [
        'user' => $user,
        'default_access' => $default_access,
        'input_params' => $input_params,
    ];
    return _elgg_services()->hooks->trigger('default', 'access', $params, $default_access);
}

function has_access_to_entity(\ElggEntity $entity, \ElggUser $user = null): bool {
    return _elgg_services()->accessCollections->hasAccessToEntity($entity, $user);
}

function get_write_access_array(int $user_guid = 0, $ignored = 0, bool $flush = false, array $input_params = []): array {
    return _elgg_services()->accessCollections->getWriteAccessArray($user_guid, $flush, $input_params);
}

function can_edit_access_collection(int $collection_id, int $user_guid = null): bool {
    return _elgg_services()->accessCollections->canEdit($collection_id, $user_guid);
}

function create_access_collection(string $name, int $owner_guid = 0, $subtype = null) {
    return _elgg_services()->accessCollections->create($name, $owner_guid, $subtype);
}

function delete_access_collection(int $collection_id): bool {
    return _elgg_services()->accessCollections->delete($collection_id);
}

function get_access_collection(int $collection_id) {
    return _elgg_services()->accessCollections->get($collection_id);
}

function add_user_to_access_collection(int $user_guid, int $collection_id): bool {
    return _elgg_services()->accessCollections->addUser($user_guid, $collection_id);
}

function remove_user_from_access_collection(int $user_guid, int $collection_id): bool {
    return _elgg_services()->accessCollections->removeUser($user_guid, $collection_id);
}

function elgg_get_access_collections(array $options = []) {
    return _elgg_services()->accessCollections->getEntityCollections($options);
}

function get_members_of_access_collection(int $collection_id, bool $guids_only = false, array $options = []) {
    if (!isset($options['limit'])) {
        $options['limit'] = false;
    }

    if (!$guids_only) {
        return _elgg_services()->accessCollections->getMembers($collection_id, $options);
    }

    $options['callback'] = function($row) {
        return (int) $row->guid;
    };
    
    return _elgg_services()->accessCollections->getMembers($collection_id, $options);
}

function get_readable_access_level(int $entity_access_id): string {
    return _elgg_services()->accessCollections->getReadableAccessLevel($entity_access_id);
}