class ShortcutSetAccessControlHandler

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

Defines the access control handler for the shortcut set entity type.

Hierarchy

Expanded class hierarchy of ShortcutSetAccessControlHandler

See also

\Drupal\shortcut\Entity\ShortcutSet

File

core/modules/shortcut/src/ShortcutSetAccessControlHandler.php, line 19

Namespace

Drupal\shortcut
View source
class ShortcutSetAccessControlHandler extends EntityAccessControlHandler implements EntityHandlerInterface {
    
    /**
     * Constructs a ShortcutSetAccessControlHandler object.
     *
     * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
     *   The entity type definition.
     * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
     *   The entity type manager.
     */
    public function __construct(EntityTypeInterface $entity_type, EntityTypeManagerInterface $entityTypeManager) {
        parent::__construct($entity_type);
    }
    
    /**
     * {@inheritdoc}
     */
    public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
        return new static($entity_type, $container->get('entity_type.manager'));
    }
    
    /**
     * {@inheritdoc}
     */
    protected function checkAccess(EntityInterface $entity, $operation, AccountInterface $account) {
        switch ($operation) {
            case 'view':
                return AccessResult::allowedIfHasPermission($account, 'access shortcuts');
            case 'update':
                if ($account->hasPermission('administer shortcuts')) {
                    return AccessResult::allowed()->cachePerPermissions();
                }
                if (!$account->hasPermission('access shortcuts')) {
                    return AccessResult::neutral()->cachePerPermissions();
                }
                $shortcut_set_storage = $this->entityTypeManager
                    ->getStorage('shortcut_set');
                return AccessResult::allowedIf($account->hasPermission('customize shortcut links') && $entity == $shortcut_set_storage->getDisplayedToUser($account))
                    ->cachePerPermissions()
                    ->addCacheableDependency($entity);
            case 'delete':
                return AccessResult::allowedIf($account->hasPermission('administer shortcuts') && $entity->id() != 'default')
                    ->cachePerPermissions();
            default:
                // No opinion.
                return AccessResult::neutral();
        }
    }
    
    /**
     * {@inheritdoc}
     */
    protected function checkCreateAccess(AccountInterface $account, array $context, $entity_bundle = NULL) {
        return AccessResult::allowedIfHasPermission($account, 'administer shortcuts')->orIf(AccessResult::allowedIfHasPermissions($account, [
            'access shortcuts',
            'customize shortcut links',
        ], 'AND'));
    }

}

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.
ShortcutSetAccessControlHandler::checkAccess protected function Performs access checks. Overrides EntityAccessControlHandler::checkAccess
ShortcutSetAccessControlHandler::checkCreateAccess protected function Performs create access checks. Overrides EntityAccessControlHandler::checkCreateAccess
ShortcutSetAccessControlHandler::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityHandlerInterface::createInstance
ShortcutSetAccessControlHandler::__construct public function Constructs a ShortcutSetAccessControlHandler 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.