access.php

Go to the documentation of this file.

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

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

function elgg_get_default_access(\ElggUser $user = null, array $input_params = []): int {
    // site default access
    $default_access = (int) _elgg_services()->config->default_access;
    
    // default to logged in user
    $user = $user ?? _elgg_services()->session_manager->getLoggedInUser();
    
    // user default access if enabled
    if (_elgg_services()->config->allow_user_default_access && $user instanceof \ElggUser) {
        $user_access = $user->elgg_default_access;
        if ($user_access !== null) {
            $default_access = (int) $user_access;
        }
    }
    
    $params = [
        'user' => $user,
        'default_access' => $default_access,
        'input_params' => $input_params,
    ];
    return (int) _elgg_services()->events->triggerResults('default', 'access', $params, $default_access);
}

function elgg_has_access_to_entity(int $entity_guid, int $user_guid = 0): bool {
    $entity = elgg_call(ELGG_IGNORE_ACCESS, function() use ($entity_guid) {
        return _elgg_services()->entityTable->get($entity_guid);
    });
    
    if (!$entity instanceof \ElggEntity) {
        return false;
    }
    
    return _elgg_services()->accessCollections->hasAccessToEntity($entity, $user_guid);
}

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

function elgg_create_access_collection(string $name, int $owner_guid = 0, string $subtype = null): ?\ElggAccessCollection {
    $acl = new \ElggAccessCollection();
    $acl->name = $name;
    $acl->owner_guid = $owner_guid ?: _elgg_services()->session_manager->getLoggedInUserGuid();
    $acl->subtype = $subtype;
    
    return $acl->save() ? $acl : null;
}

function elgg_get_access_collection(int $collection_id): ?\ElggAccessCollection {
    return _elgg_services()->accessCollections->get($collection_id);
}

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

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