interface.ilRBACAccessHandler.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

interface ilRBACAccessHandler
{
    public function storeAccessResult(
        string $a_permission,
        string $a_cmd,
        int $a_ref_id,
        bool $a_access_granted,
        ?int $a_user_id = null,
        ?ilAccessInfo $a_info = null
    ): void;

    public function getStoredAccessResult(
        string $a_permission,
        string $a_cmd,
        int $a_ref_id,
        ?int $a_user_id = null
    ): array;

    public function setPreventCachingLastResult(bool $a_val): void;

    public function getPreventCachingLastResult(): bool;

    public function storeCache(): void;

    public function readCache(int $a_secs = 0): bool;

    public function getResults(): array;

    public function setResults(array $a_results);

    public function addInfoItem(string $a_type, string $a_text, string $a_data = ""): void;

    public function checkAccess(
        string $a_permission,
        string $a_cmd,
        int $a_ref_id,
        string $a_type = "",
        ?int $a_obj_id = null,
        ?int $a_tree_id = null
    ): bool;

    public function checkAccessOfUser(
        int $a_user_id,
        string $a_permission,
        string $a_cmd,
        int $a_ref_id,
        string $a_type = "",
        ?int $a_obj_id = null,
        ?int $a_tree_id = null
    ): bool;

    public function getInfo(): array;

    public function getResultLast(): array;

    public function getResultAll(int $a_ref_id = 0): array;

    public function doCacheCheck(
        string $a_permission,
        string $a_cmd,
        int $a_ref_id,
        int $a_user_id
    ): array;

    public function doTreeCheck(
        string $a_permission,
        string $a_cmd,
        int $a_ref_id,
        int $a_user_id
    ): bool;

    public function doRBACCheck(
        string $a_permission,
        string $a_cmd,
        int $a_ref_id,
        int $a_user_id,
        string $a_type
    ): bool;

    public function doPathCheck(
        string $a_permission,
        string $a_cmd,
        int $a_ref_id,
        int $a_user_id,
        bool $a_all = false
    ): bool;

    public function doActivationCheck(
        string $a_permission,
        string $a_cmd,
        int $a_ref_id,
        int $a_user_id,
        int $a_obj_id,
        string $a_type
    ): bool;

    public function doConditionCheck(
        string $a_permission,
        string $a_cmd,
        int $a_ref_id,
        int $a_user_id,
        int $a_obj_id,
        string $a_type
    ): bool;

    public function doStatusCheck(
        string $a_permission,
        string $a_cmd,
        int $a_ref_id,
        int $a_user_id,
        int $a_obj_id,
        string $a_type
    ): bool;

    public function clear(): void;

    public function enable(string $a_str, bool $a_bool): void;
}