access.php

Go to the documentation of this file.

<?php
global $ENTITY_SHOW_HIDDEN_OVERRIDE;

function elgg_set_ignore_access($ignore = true) {
    return elgg()->session->setIgnoreAccess($ignore);
}

function elgg_get_ignore_access() {
    return elgg()->session->getIgnoreAccess();
}

function get_access_list($user_guid = 0, $ignored = 0, $flush = false) {
    return _elgg_services()->accessCollections->getAccessList($user_guid, $flush);
}

function get_access_array($user_guid = 0, $ignored = 0, $flush = false) {
    return _elgg_services()->accessCollections->getAccessArray($user_guid, $flush);
}

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

    // user default access if enabled
    if (_elgg_config()->allow_user_default_access) {
        $user = $user ? $user : elgg()->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 access_show_hidden_entities($show_hidden) {
    elgg()->session->setDisabledEntityVisibility($show_hidden);
}

function access_get_show_hidden_status() {
    return elgg()->session->getDisabledEntityVisibility();
}

function has_access_to_entity($entity, $user = null) {
    return _elgg_services()->accessCollections->hasAccessToEntity($entity, $user);
}

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

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

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

function update_access_collection($collection_id, $members) {
    return _elgg_services()->accessCollections->update($collection_id, $members);
}

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

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

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

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

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

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

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

    $guids = [];
    $options['callback'] = false;
    $rows = _elgg_services()->accessCollections->getMembers($collection_id, $options);
    foreach ($rows as $row) {
        $guids[] = (int) $row->guid;
    }
    return $guids;
}
function get_readable_access_level($entity_access_id) {
    return _elgg_services()->accessCollections->getReadableAccessLevel($entity_access_id);
}

function access_init() {
    _elgg_services()->accessCollections->markInitComplete();
}

function access_friends_acl_create(\Elgg\Event $event) {
    $user = $event->getObject();
    if (!($user instanceof \ElggUser)) {
        return;
    }
    
    create_access_collection('friends', $user->guid, 'friends');
}

function access_friends_acl_add_friend(\Elgg\Event $event) {
    $relationship_object = $event->getObject();
    if (!($relationship_object instanceof \ElggRelationship)) {
        return;
    }
    
    if ($relationship_object->relationship !== 'friend') {
        return;
    }
    
    $user = get_user($relationship_object->guid_one);
    $friend = get_user($relationship_object->guid_two);
    
    if (!$user || !$friend) {
        return;
    }
    
    $acl = $user->getOwnedAccessCollection('friends');
    if (empty($acl)) {
        return;
    }
    $acl->addMember($friend->guid);
}

function access_friends_acl_remove_friend(\Elgg\Event $event) {
    $relationship_object = $event->getObject();
    if (!($relationship_object instanceof \ElggRelationship)) {
        return;
    }
    
    if ($relationship_object->relationship !== 'friend') {
        return;
    }
    
    $user = get_user($relationship_object->guid_one);
    $friend = get_user($relationship_object->guid_two);
    
    if (!$user || !$friend) {
        return;
    }
    
    $acl = $user->getOwnedAccessCollection('friends');
    if (empty($acl)) {
        return;
    }
    
    $acl->removeMember($friend->guid);
}

function access_friends_acl_get_name(\Elgg\Hook $hook) {
    $access_collection = $hook->getParam('access_collection');
    if (!($access_collection instanceof ElggAccessCollection)) {
        return;
    }
    
    if ($access_collection->getSubtype() !== 'friends') {
        return;
    }
    
    return elgg_echo('access:label:friends');
}

function access_test($hook, $type, $value, $params) {
    $value[] = ElggCoreAccessCollectionsTest::class;
    return $value;
}

return function(\Elgg\EventsService $events, \Elgg\HooksRegistrationService $hooks) {
    // Tell the access functions the system has booted, plugins are loaded,
    // and the user is logged in so it can start caching
    $events->registerHandler('ready', 'system', 'access_init');
    
    // friends ACL events
    $events->registerHandler('create', 'user', 'access_friends_acl_create');
    $events->registerHandler('create', 'relationship', 'access_friends_acl_add_friend');
    $events->registerHandler('delete', 'relationship', 'access_friends_acl_remove_friend');
    $hooks->registerHandler('access_collection:name', 'access_collection', 'access_friends_acl_get_name');

    $hooks->registerHandler('unit_test', 'system', 'access_test');
};