interface EntityAccessControlHandlerInterface
Same name in other branches
- 9 core/lib/Drupal/Core/Entity/EntityAccessControlHandlerInterface.php \Drupal\Core\Entity\EntityAccessControlHandlerInterface
- 8.9.x core/lib/Drupal/Core/Entity/EntityAccessControlHandlerInterface.php \Drupal\Core\Entity\EntityAccessControlHandlerInterface
- 11.x core/lib/Drupal/Core/Entity/EntityAccessControlHandlerInterface.php \Drupal\Core\Entity\EntityAccessControlHandlerInterface
Defines an interface for entity access control handlers.
Hierarchy
- interface \Drupal\Core\Entity\EntityAccessControlHandlerInterface
Expanded class hierarchy of EntityAccessControlHandlerInterface
All classes that implement EntityAccessControlHandlerInterface
2 files declare their use of EntityAccessControlHandlerInterface
- FileAccessFormatterControlHandlerInterface.php in core/
modules/ file/ src/ FileAccessFormatterControlHandlerInterface.php - ForumController.php in core/
modules/ forum/ src/ Controller/ ForumController.php
File
-
core/
lib/ Drupal/ Core/ Entity/ EntityAccessControlHandlerInterface.php, line 13
Namespace
Drupal\Core\EntityView source
interface EntityAccessControlHandlerInterface {
/**
* Checks access to an operation on a given entity or entity translation.
*
* Use \Drupal\Core\Entity\EntityAccessControlHandlerInterface::createAccess()
* to check access to create an entity.
*
* @param \Drupal\Core\Entity\EntityInterface $entity
* The entity for which to check access.
* @param string $operation
* The operation access should be checked for.
* Usually one of "view", "view label", "update" or "delete".
* @param \Drupal\Core\Session\AccountInterface $account
* (optional) The user session for which to check access, or NULL to check
* access for the current user. Defaults to NULL.
* @param bool $return_as_object
* (optional) Defaults to FALSE.
*
* @return bool|\Drupal\Core\Access\AccessResultInterface
* The access result. Returns a boolean if $return_as_object is FALSE (this
* is the default) and otherwise an AccessResultInterface object.
* When a boolean is returned, the result of AccessInterface::isAllowed() is
* returned, i.e. TRUE means access is explicitly allowed, FALSE means
* access is either explicitly forbidden or "no opinion".
*/
public function access(EntityInterface $entity, $operation, ?AccountInterface $account = NULL, $return_as_object = FALSE);
/**
* Checks access to create an entity.
*
* @param string $entity_bundle
* (optional) The bundle of the entity. Required if the entity supports
* bundles, defaults to NULL otherwise.
* @param \Drupal\Core\Session\AccountInterface $account
* (optional) The user session for which to check access, or NULL to check
* access for the current user. Defaults to NULL.
* @param array $context
* (optional) An array of key-value pairs to pass additional context when
* needed.
* @param bool $return_as_object
* (optional) Defaults to FALSE.
*
* @return bool|\Drupal\Core\Access\AccessResultInterface
* The access result. Returns a boolean if $return_as_object is FALSE (this
* is the default) and otherwise an AccessResultInterface object.
* When a boolean is returned, the result of AccessInterface::isAllowed() is
* returned, i.e. TRUE means access is explicitly allowed, FALSE means
* access is either explicitly forbidden or "no opinion".
*/
public function createAccess($entity_bundle = NULL, ?AccountInterface $account = NULL, array $context = [], $return_as_object = FALSE);
/**
* Clears all cached access checks.
*/
public function resetCache();
/**
* Sets the module handler for this access control handler.
*
* @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
* The module handler.
*
* @return $this
*/
public function setModuleHandler(ModuleHandlerInterface $module_handler);
/**
* Checks access to an operation on a given entity field.
*
* This method does not determine whether access is granted to the entity
* itself, only the specific field. Callers are responsible for ensuring that
* entity access is also respected, for example by using
* \Drupal\Core\Entity\EntityAccessControlHandlerInterface::access().
*
* @param string $operation
* The operation access should be checked for. Usually one of "view" or
* "edit". Unlike entity access, for field access there is no distinction
* between creating and updating.
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition.
* @param \Drupal\Core\Session\AccountInterface $account
* (optional) The user session for which to check access, or NULL to check
* access for the current user. Defaults to NULL.
* @param \Drupal\Core\Field\FieldItemListInterface $items
* (optional) The field values for which to check access, or NULL if access
* is checked for the field definition, without any specific value
* available. Defaults to NULL.
* @param bool $return_as_object
* (optional) Defaults to FALSE.
*
* @return bool|\Drupal\Core\Access\AccessResultInterface
* The access result. Returns a boolean if $return_as_object is FALSE (this
* is the default) and otherwise an AccessResultInterface object.
* When a boolean is returned, the result of AccessInterface::isAllowed() is
* returned, i.e. TRUE means access is explicitly allowed, FALSE means
* access is either explicitly forbidden or "no opinion".
*
* @see \Drupal\Core\Entity\EntityAccessControlHandlerInterface::access()
*/
public function fieldAccess($operation, FieldDefinitionInterface $field_definition, ?AccountInterface $account = NULL, ?FieldItemListInterface $items = NULL, $return_as_object = FALSE);
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overrides |
---|---|---|---|---|
EntityAccessControlHandlerInterface::access | public | function | Checks access to an operation on a given entity or entity translation. | 1 |
EntityAccessControlHandlerInterface::createAccess | public | function | Checks access to create an entity. | 1 |
EntityAccessControlHandlerInterface::fieldAccess | public | function | Checks access to an operation on a given entity field. | 1 |
EntityAccessControlHandlerInterface::resetCache | public | function | Clears all cached access checks. | 1 |
EntityAccessControlHandlerInterface::setModuleHandler | public | function | Sets the module handler for this access control handler. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.