interface NodeAccessControlHandlerInterface (View source)

Node specific entity access control methods.

Methods

array
acquireGrants(NodeInterface $node)

Gets the list of node access grants.

writeDefaultGrant()

Creates the default node access grant entry on the grant storage.

deleteGrants()

Deletes all node access entries.

int
countGrants()

Counts available node grants.

int
checkAllGrants(AccountInterface $account)

Checks all grants for a given account.

Details

array acquireGrants(NodeInterface $node)

Gets the list of node access grants.

This function is called to check the access grants for a node. It collects all node access grants for the node from hook_node_access_records() implementations, allows these grants to be altered via hook_node_access_records_alter() implementations, and returns the grants to the caller.

Parameters

NodeInterface $node

The $node to acquire grants for.

Return Value

array

The access rules for the node.

writeDefaultGrant()

Creates the default node access grant entry on the grant storage.

deleteGrants()

Deletes all node access entries.

int countGrants()

Counts available node grants.

Return Value

int

Returns the amount of node grants.

int checkAllGrants(AccountInterface $account)

Checks all grants for a given account.

Parameters

AccountInterface $account

A user object representing the user for whom the operation is to be performed.

Return Value

int

Status of the access check.