class ShortcutAccessControlHandler

Same name in other branches
  1. 9 core/modules/shortcut/src/ShortcutAccessControlHandler.php \Drupal\shortcut\ShortcutAccessControlHandler
  2. 8.9.x core/modules/shortcut/src/ShortcutAccessControlHandler.php \Drupal\shortcut\ShortcutAccessControlHandler
  3. 10 core/modules/shortcut/src/ShortcutAccessControlHandler.php \Drupal\shortcut\ShortcutAccessControlHandler

Defines the access control handler for the shortcut entity type.

Hierarchy

Expanded class hierarchy of ShortcutAccessControlHandler

See also

\Drupal\shortcut\Entity\Shortcut

1 file declares its use of ShortcutAccessControlHandler
Shortcut.php in core/modules/shortcut/src/Entity/Shortcut.php

File

core/modules/shortcut/src/ShortcutAccessControlHandler.php, line 18

Namespace

Drupal\shortcut
View source
class ShortcutAccessControlHandler extends EntityAccessControlHandler implements EntityHandlerInterface {
    
    /**
     * The shortcut_set storage.
     *
     * @var \Drupal\shortcut\ShortcutSetStorageInterface
     */
    protected $shortcutSetStorage;
    
    /**
     * Constructs a ShortcutAccessControlHandler object.
     *
     * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
     *   The entity type definition.
     * @param \Drupal\shortcut\ShortcutSetStorageInterface $shortcut_set_storage
     *   The shortcut_set storage.
     */
    public function __construct(EntityTypeInterface $entity_type, ShortcutSetStorageInterface $shortcut_set_storage) {
        parent::__construct($entity_type);
        $this->shortcutSetStorage = $shortcut_set_storage;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
        return new static($entity_type, $container->get('entity_type.manager')
            ->getStorage('shortcut_set'));
    }
    
    /**
     * {@inheritdoc}
     */
    protected function checkAccess(EntityInterface $entity, $operation, AccountInterface $account) {
        if ($shortcut_set = $this->shortcutSetStorage
            ->load($entity->bundle())) {
            return shortcut_set_edit_access($shortcut_set);
        }
        // @todo Fix this bizarre code: how can a shortcut exist without a shortcut
        // set? The above if-test is unnecessary. See https://www.drupal.org/node/2339903.
        return AccessResult::neutral()->addCacheableDependency($entity);
    }
    
    /**
     * {@inheritdoc}
     */
    protected function checkCreateAccess(AccountInterface $account, array $context, $entity_bundle = NULL) {
        if ($shortcut_set = $this->shortcutSetStorage
            ->load($entity_bundle)) {
            return shortcut_set_edit_access($shortcut_set);
        }
        // @todo Fix this bizarre code: how can a shortcut exist without a shortcut
        // set? The above if-test is unnecessary. See https://www.drupal.org/node/2339903.
        return AccessResult::neutral();
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
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. 7
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 Determines entity access.
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. 5
EntityHandlerBase::moduleHandler protected function Gets the module handler. 5
EntityHandlerBase::setModuleHandler public function Sets the module handler for this handler.
ShortcutAccessControlHandler::$shortcutSetStorage protected property The shortcut_set storage.
ShortcutAccessControlHandler::checkAccess protected function Performs access checks. Overrides EntityAccessControlHandler::checkAccess
ShortcutAccessControlHandler::checkCreateAccess protected function Performs create access checks. Overrides EntityAccessControlHandler::checkCreateAccess
ShortcutAccessControlHandler::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityHandlerInterface::createInstance
ShortcutAccessControlHandler::__construct public function Constructs a ShortcutAccessControlHandler object. Overrides EntityAccessControlHandler::__construct
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
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.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.