You are here

class BackgroundImageAccessControlHandler in Background Image 8

Same name and namespace in other branches
  1. 2.x src/BackgroundImageAccessControlHandler.php \Drupal\background_image\BackgroundImageAccessControlHandler
  2. 2.0.x src/BackgroundImageAccessControlHandler.php \Drupal\background_image\BackgroundImageAccessControlHandler

Access controller for the Background Image entity.

Hierarchy

Expanded class hierarchy of BackgroundImageAccessControlHandler

See also

\Drupal\background_image\Entity\BackgroundImage.

File

src/BackgroundImageAccessControlHandler.php, line 15

Namespace

Drupal\background_image
View source
class BackgroundImageAccessControlHandler 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) {

    /** @type \Drupal\background_image\Entity\BackgroundImage $entity */
    switch ($operation) {
      case 'view':
        return AccessResult::allowedIfHasPermission($account, 'view background image');
      case 'edit':
      case 'update':
        if ($entity
          ->getOwnerId() === $account
          ->id()) {
          return AccessResult::allowedIfHasPermission($account, 'edit own background image')
            ->orIf(AccessResult::allowedIfHasPermission($account, 'edit background image'));
        }
        return AccessResult::allowedIfHasPermission($account, 'edit background image');
      case 'delete':
        if ($entity
          ->getOwnerId() === $account
          ->id()) {
          return AccessResult::allowedIfHasPermission($account, 'delete own background image')
            ->orIf(AccessResult::allowedIfHasPermission($account, 'delete background image'));
        }
        return AccessResult::allowedIfHasPermission($account, 'delete background image');
    }
    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) {
    return AccessResult::allowedIfHasPermission($account, 'add background image');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BackgroundImageAccessControlHandler::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
BackgroundImageAccessControlHandler::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 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.