Documentation

CheckAccessTrait

Define an implementation of `civi.api4.authorizeRecord` in which access-control decisions are based on a predefined list. For example:

$this->setCheckAccessGrants(['Contact::create' => TRUE]); Contact::create()->setValues(...)->execute();

Note: Any class which uses this should implement the HookInterface so that the hook is picked up.

$checkAccessCounts : array<string|int, mixed>: Number of times hook_checkAccess has fired.
$checkAccessGrants : array<string|int, mixed>: Specify whether to grant access to an entity-action via hook_checkAccess.

on_civi_api4_authorizeRecord() : void: Listen to 'civi.api4.authorizeRecord'. Override decisions with specified grants.
resetCheckAccess() : mixed
setCheckAccessGrants() : mixed

Number of times hook_checkAccess has fired.


    protected
        array<string|int, mixed>
    $checkAccessCounts
     = []

Specify whether to grant access to an entity-action via hook_checkAccess.


    private
        array<string|int, mixed>
    $checkAccessGrants
     = []

Array(string $entityAction => bool $grant). TRUE=>Allow. FALSE=>Deny. Undefined=>No preference.

Listen to 'civi.api4.authorizeRecord'. Override decisions with specified grants.


    public
                    on_civi_api4_authorizeRecord(AuthorizeRecordEvent $e) : void


    protected
                    resetCheckAccess() : mixed


    protected
                    setCheckAccessGrants(array<string|int, mixed> $list) : mixed

$list : array<string|int, mixed>: Ex: ["Event::delete" => TRUE, "Contribution::delete" => FALSE]