gatekeepers.php

Go to the documentation of this file.

<?php
use Elgg\Exceptions\Http\Gatekeeper\GroupToolGatekeeperException;

function elgg_group_tool_gatekeeper(string $tool_name, ?int $group_guid = null): void {
    $group_guid = $group_guid ?? elgg_get_page_owner_guid();
    
    $group = get_entity($group_guid);
    if (!$group instanceof \ElggGroup) {
        return;
    }
    
    if ($group->isToolEnabled($tool_name)) {
        return;
    }
    
    $ex = new GroupToolGatekeeperException();
    $ex->setRedirectUrl($group->getURL());
    $ex->setParams([
        'entity' => $group,
        'tool' => $tool_name,
    ]);
    
    throw $ex;
}

function elgg_signed_request_gatekeeper(): void {
    if (\Elgg\Application::isCli()) {
        return;
    }
    
    _elgg_services()->urlSigner->assertValid(elgg_get_current_url());
}

function elgg_gatekeeper(): void {
    _elgg_services()->gatekeeper->assertAuthenticatedUser();
}

function elgg_admin_gatekeeper(): void {
    _elgg_services()->gatekeeper->assertAuthenticatedAdmin();
}

function elgg_entity_gatekeeper(int $guid, ?string $type = null, ?string $subtype = null, bool $validate_can_edit = false): void {
    $entity = _elgg_services()->gatekeeper->assertExists($guid, $type, $subtype);
    _elgg_services()->gatekeeper->assertAccessibleEntity($entity, null, $validate_can_edit);
}

function elgg_ajax_gatekeeper(): void {
    _elgg_services()->gatekeeper->assertXmlHttpRequest();
}