class ContactAccessControlHandler in Examples for Developers 3.x

Access controller for the contact entity.

Hierarchy

• class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
  • class \Drupal\Core\Entity\EntityAccessControlHandler implements EntityAccessControlHandlerInterface
    • class \Drupal\content_entity_example\ContactAccessControlHandler

File

modules/content_entity_example/src/ContactAccessControlHandler.php, line 13

Namespace

Drupal\content_entity_example

class ContactAccessControlHandler extends EntityAccessControlHandler {

  /**
   * {@inheritdoc}
   *
   * Link the activities to the permissions. checkAccess() is called with the
   * $operation as defined in the routing.yml file.
   */
  protected function checkAccess(EntityInterface $entity, $operation, AccountInterface $account) {

    // Check the admin_permission as defined in your @ContentEntityType
    // annotation.
    $admin_permission = $this->entityType
      ->getAdminPermission();
    if ($account
      ->hasPermission($admin_permission)) {
      return AccessResult::allowed();
    }
    switch ($operation) {
      case 'view':
        return AccessResult::allowedIfHasPermission($account, 'view contact entity');
      case 'update':
        return AccessResult::allowedIfHasPermission($account, 'edit contact entity');
      case 'delete':
        return AccessResult::allowedIfHasPermission($account, 'delete contact entity');
    }
    return AccessResult::neutral();
  }

  /**
   * {@inheritdoc}
   *
   * Separate from the checkAccess because the entity does not yet exist. It
   * will be created during the 'add' process.
   */
  protected function checkCreateAccess(AccountInterface $account, array $context, $entity_bundle = NULL) {

    // Check the admin_permission as defined in your @ContentEntityType
    // annotation.
    $admin_permission = $this->entityType
      ->getAdminPermission();
    if ($account
      ->hasPermission($admin_permission)) {
      return AccessResult::allowed();
    }
    return AccessResult::allowedIfHasPermission($account, 'add contact entity');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ContactAccessControlHandler::checkAccess	protected	function	Link the activities to the permissions. checkAccess() is called with the $operation as defined in the routing.yml file. Overrides EntityAccessControlHandler::checkAccess
ContactAccessControlHandler::checkCreateAccess	protected	function	Separate from the checkAccess because the entity does not yet exist. It will be created during the 'add' process. Overrides EntityAccessControlHandler::checkCreateAccess
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
EntityAccessControlHandler::$accessCache	protected	property	Stores calculated access check results.
EntityAccessControlHandler::$entityType	protected	property	Information about the entity type.
EntityAccessControlHandler::$entityTypeId	protected	property	The entity type ID of the access control handler instance.
EntityAccessControlHandler::$viewLabelOperation	protected	property	Allows to grant access to just the labels.	5
EntityAccessControlHandler::access	public	function	Checks access to an operation on a given entity or entity translation. Overrides EntityAccessControlHandlerInterface::access	1
EntityAccessControlHandler::checkFieldAccess	protected	function	Default field access as determined by this access control handler.	4
EntityAccessControlHandler::createAccess	public	function	Checks access to create an entity. Overrides EntityAccessControlHandlerInterface::createAccess	1
EntityAccessControlHandler::fieldAccess	public	function	Checks access to an operation on a given entity field. Overrides EntityAccessControlHandlerInterface::fieldAccess
EntityAccessControlHandler::getCache	protected	function	Tries to retrieve a previously cached access value from the static cache.
EntityAccessControlHandler::prepareUser	protected	function	Loads the current account object, if it does not exist yet.
EntityAccessControlHandler::processAccessHookResults	protected	function	We grant access to the entity if both of these conditions are met:
EntityAccessControlHandler::resetCache	public	function	Clears all cached access checks. Overrides EntityAccessControlHandlerInterface::resetCache
EntityAccessControlHandler::setCache	protected	function	Statically caches whether the given user has access.
EntityAccessControlHandler::__construct	public	function	Constructs an access control handler instance.	6
EntityHandlerBase::$moduleHandler	protected	property	The module handler to invoke hooks on.	5
EntityHandlerBase::moduleHandler	protected	function	Gets the module handler.	5
EntityHandlerBase::setModuleHandler	public	function	Sets the module handler for this handler.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.