class CacheflushEntityAccessControlHandler in CacheFlush 8

Access controller for the Cacheflush entity.

Hierarchy

• class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
  • class \Drupal\Core\Entity\EntityAccessControlHandler implements EntityAccessControlHandlerInterface
    • class \Drupal\cacheflush_ui\CacheflushEntityAccessControlHandler

See also

\Drupal\cacheflush_ui\Entity\CacheflushEntity.

File

modules/cacheflush_ui/src/CacheflushEntityAccessControlHandler.php, line 15

Namespace

Drupal\cacheflush_ui

class CacheflushEntityAccessControlHandler extends EntityAccessControlHandler {

  /**
   * {@inheritdoc}
   */
  protected function checkAccess(EntityInterface $entity, $operation, AccountInterface $account) {
    switch ($operation) {
      case 'clear':
        return $this
          ->checkSingleToMany('cacheflush clear any', 'cacheflush clear own', $account, $entity);
      case 'view':
        return $this
          ->checkSingleToMany('cacheflush view any', 'cacheflush view own', $account, $entity);
      case 'update':
        return $this
          ->checkSingleToMany('cacheflush edit any', 'cacheflush edit own', $account, $entity);
      case 'delete':
        return $this
          ->checkSingleToMany('cacheflush delete any', 'cacheflush delete own', $account, $entity);
    }
    return AccessResult::allowed();
  }

  /**
   * {@inheritdoc}
   */
  protected function checkCreateAccess(AccountInterface $account, array $context, $entity_bundle = NULL) {
    return AccessResult::allowedIfHasPermission($account, 'cacheflush create new');
  }

  /**
   * Check access for 'any' and 'own' permissions.
   *
   * @param string $any
   *   Permission string for any content.
   * @param string $single
   *   Permission string for own content.
   * @param object $account
   *   User account to check.
   * @param object $entity
   *   The entity object.
   *
   * @return bool
   *   Return TRUE if access is granted.
   */
  protected function checkSingleToMany($any, $single, $account, $entity) {
    return AccessResult::allowedIfHasPermission($account, $any)
      ->orIf(AccessResult::allowedIfHasPermission($account, $single)
      ->andIf($this
      ->checkOwner($account, $entity)));
  }

  /**
   * Check entity owner.
   *
   * @param object $account
   *   User account to check.
   * @param object $entity
   *   The entity object.
   *
   * @return \Drupal\Core\Access\AccessResult
   *   Access result.
   */
  protected function checkOwner($account, $entity) {
    if ($account
      ->id() == $entity
      ->getOwnerId()) {
      return AccessResult::allowed();
    }
    return AccessResult::neutral();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CacheflushEntityAccessControlHandler::checkAccess	protected	function	Performs access checks. Overrides EntityAccessControlHandler::checkAccess
CacheflushEntityAccessControlHandler::checkCreateAccess	protected	function	Performs create access checks. Overrides EntityAccessControlHandler::checkCreateAccess
CacheflushEntityAccessControlHandler::checkOwner	protected	function	Check entity owner.
CacheflushEntityAccessControlHandler::checkSingleToMany	protected	function	Check access for 'any' and 'own' permissions.
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
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.	5
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.