interface NodeAccessControlHandlerInterface
Same name in other branches
- 9 core/modules/node/src/NodeAccessControlHandlerInterface.php \Drupal\node\NodeAccessControlHandlerInterface
- 8.9.x core/modules/node/src/NodeAccessControlHandlerInterface.php \Drupal\node\NodeAccessControlHandlerInterface
- 11.x core/modules/node/src/NodeAccessControlHandlerInterface.php \Drupal\node\NodeAccessControlHandlerInterface
Node specific entity access control methods.
Hierarchy
- interface \Drupal\node\NodeAccessControlHandlerInterface
Expanded class hierarchy of NodeAccessControlHandlerInterface
All classes that implement NodeAccessControlHandlerInterface
Related topics
File
-
core/
modules/ node/ src/ NodeAccessControlHandlerInterface.php, line 12
Namespace
Drupal\nodeView source
interface NodeAccessControlHandlerInterface {
/**
* 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.
*
* @param \Drupal\node\NodeInterface $node
* The $node to acquire grants for.
*
* @return array
* The access rules for the node.
*/
public function acquireGrants(NodeInterface $node);
/**
* Creates the default node access grant entry on the grant storage.
*/
public function writeDefaultGrant();
/**
* Deletes all node access entries.
*/
public function deleteGrants();
/**
* Counts available node grants.
*
* @return int
* Returns the amount of node grants.
*/
public function countGrants();
/**
* Checks all grants for a given account.
*
* @param \Drupal\Core\Session\AccountInterface $account
* A user object representing the user for whom the operation is to be
* performed.
*
* @return int
* Status of the access check.
*/
public function checkAllGrants(AccountInterface $account);
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overrides |
---|---|---|---|---|
NodeAccessControlHandlerInterface::acquireGrants | public | function | Gets the list of node access grants. | 1 |
NodeAccessControlHandlerInterface::checkAllGrants | public | function | Checks all grants for a given account. | 1 |
NodeAccessControlHandlerInterface::countGrants | public | function | Counts available node grants. | 1 |
NodeAccessControlHandlerInterface::deleteGrants | public | function | Deletes all node access entries. | 1 |
NodeAccessControlHandlerInterface::writeDefaultGrant | public | function | Creates the default node access grant entry on the grant storage. | 1 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.