class DomainAccessControlHandler in Domain Access 8

Defines the access controller for the domain entity type.

Note that this is not a node access check.

Hierarchy

• class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
  • class \Drupal\Core\Entity\EntityAccessControlHandler implements EntityAccessControlHandlerInterface
    • class \Drupal\domain\DomainAccessControlHandler implements EntityHandlerInterface

1 file declares its use of DomainAccessControlHandler

DomainAliasAccessControlHandler.php in domain_alias/src/DomainAliasAccessControlHandler.php

File

domain/src/DomainAccessControlHandler.php, line 21

Namespace

Drupal\domain

class DomainAccessControlHandler extends EntityAccessControlHandler implements EntityHandlerInterface {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The domain field element manager.
   *
   * @var \Drupal\domain\DomainElementManagerInterface
   */
  protected $domainElementManager;

  /**
   * The user storage manager.
   *
   * @var \Drupal\user\UserStorageInterface
   */
  protected $userStorage;

  /**
   * Constructs an access control handler instance.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type definition.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\domain\DomainElementManagerInterface $domain_element_manager
   *   The domain field element manager.
   * @param \Drupal\user\UserStorageInterface $user_storage
   *   The user storage manager.
   */
  public function __construct(EntityTypeInterface $entity_type, EntityTypeManagerInterface $entity_type_manager, DomainElementManagerInterface $domain_element_manager, UserStorageInterface $user_storage) {
    parent::__construct($entity_type);
    $this->entityTypeManager = $entity_type_manager;
    $this->domainElementManager = $domain_element_manager;
    $this->userStorage = $user_storage;
  }

  /**
   * {@inheritdoc}
   */
  public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
    return new static($entity_type, $container
      ->get('entity_type.manager'), $container
      ->get('domain.element_manager'), $container
      ->get('entity_type.manager')
      ->getStorage('user'));
  }

  /**
   * {@inheritdoc}
   */
  public function checkAccess(EntityInterface $entity, $operation, AccountInterface $account = NULL) {
    $account = $this
      ->prepareUser($account);

    // Check the global permission.
    if ($account
      ->hasPermission('administer domains')) {
      return AccessResult::allowed();
    }

    // For view, we allow admins unless the domain is inactive.
    $is_admin = $this
      ->isDomainAdmin($entity, $account);
    if ($operation == 'view' && ($entity
      ->status() || $account
      ->hasPermission('access inactive domains')) && ($is_admin || $account
      ->hasPermission('view domain list'))) {
      return AccessResult::allowed();
    }

    // For other operations, check that the user is a domain admin.
    if ($operation == 'update' && $account
      ->hasPermission('edit assigned domains') && $is_admin) {
      return AccessResult::allowed();
    }
    if ($operation == 'delete' && $account
      ->hasPermission('delete assigned domains') && $is_admin) {
      return AccessResult::allowed();
    }
    return AccessResult::forbidden();
  }

  /**
   * {@inheritdoc}
   */
  protected function checkCreateAccess(AccountInterface $account, array $context, $entity_bundle = NULL) {
    if ($account
      ->hasPermission('administer domains') || $account
      ->hasPermission('create domains')) {
      return AccessResult::allowed();
    }
    return AccessResult::neutral();
  }

  /**
   * Checks if a user can administer a specific domain.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity to retrieve field data from.
   * @param \Drupal\Core\Session\AccountInterface $account
   *   The user account.
   *
   * @return bool
   *   TRUE if a user can administer a specific domain, or FALSE.
   */
  public function isDomainAdmin(EntityInterface $entity, AccountInterface $account) {
    $user = $this->userStorage
      ->load($account
      ->id());
    $user_domains = $this->domainElementManager
      ->getFieldValues($user, DomainInterface::DOMAIN_ADMIN_FIELD);
    return isset($user_domains[$entity
      ->id()]);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
DomainAccessControlHandler::$domainElementManager	protected	property	The domain field element manager.
DomainAccessControlHandler::$entityTypeManager	protected	property	The entity type manager.
DomainAccessControlHandler::$userStorage	protected	property	The user storage manager.
DomainAccessControlHandler::checkAccess	public	function	Performs access checks. Overrides EntityAccessControlHandler::checkAccess	1
DomainAccessControlHandler::checkCreateAccess	protected	function	Performs create access checks. Overrides EntityAccessControlHandler::checkCreateAccess
DomainAccessControlHandler::createInstance	public static	function	Instantiates a new instance of this entity handler. Overrides EntityHandlerInterface::createInstance
DomainAccessControlHandler::isDomainAdmin	public	function	Checks if a user can administer a specific domain.
DomainAccessControlHandler::__construct	public	function	Constructs an access control handler instance. Overrides EntityAccessControlHandler::__construct
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.
EntityHandlerBase::$moduleHandler	protected	property	The module handler to invoke hooks on.	2
EntityHandlerBase::moduleHandler	protected	function	Gets the module handler.	2
EntityHandlerBase::setModuleHandler	public	function	Sets the module handler for this handler.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
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.