class MenuLinkContentAccessControlHandler

Same name in other branches
  1. 9 core/modules/menu_link_content/src/MenuLinkContentAccessControlHandler.php \Drupal\menu_link_content\MenuLinkContentAccessControlHandler
  2. 10 core/modules/menu_link_content/src/MenuLinkContentAccessControlHandler.php \Drupal\menu_link_content\MenuLinkContentAccessControlHandler
  3. 11.x core/modules/menu_link_content/src/MenuLinkContentAccessControlHandler.php \Drupal\menu_link_content\MenuLinkContentAccessControlHandler

Defines the access control handler for the user entity type.

Hierarchy

Expanded class hierarchy of MenuLinkContentAccessControlHandler

1 file declares its use of MenuLinkContentAccessControlHandler
MenuLinkContentEntityAccessTest.php in core/modules/menu_link_content/tests/src/Unit/MenuLinkContentEntityAccessTest.php

File

core/modules/menu_link_content/src/MenuLinkContentAccessControlHandler.php, line 17

Namespace

Drupal\menu_link_content
View source
class MenuLinkContentAccessControlHandler extends EntityAccessControlHandler implements EntityHandlerInterface {
    
    /**
     * The access manager to check routes by name.
     *
     * @var \Drupal\Core\Access\AccessManagerInterface
     */
    protected $accessManager;
    
    /**
     * Creates a new MenuLinkContentAccessControlHandler.
     *
     * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
     *   The entity type definition.
     * @param \Drupal\Core\Access\AccessManagerInterface $access_manager
     *   The access manager to check routes by name.
     */
    public function __construct(EntityTypeInterface $entity_type, AccessManagerInterface $access_manager) {
        parent::__construct($entity_type);
        $this->accessManager = $access_manager;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
        return new static($entity_type, $container->get('access_manager'));
    }
    
    /**
     * {@inheritdoc}
     */
    protected function checkAccess(EntityInterface $entity, $operation, AccountInterface $account) {
        switch ($operation) {
            case 'view':
                // There is no direct viewing of a menu link, but still for purposes of
                // content_translation we need a generic way to check access.
                return AccessResult::allowedIfHasPermission($account, 'administer menu');
            case 'update':
                if (!$account->hasPermission('administer menu')) {
                    return AccessResult::neutral("The 'administer menu' permission is required.")->cachePerPermissions();
                }
                else {
                    // Assume that access is allowed.
                    $access = AccessResult::allowed()->cachePerPermissions()
                        ->addCacheableDependency($entity);
                    
                    /** @var \Drupal\menu_link_content\MenuLinkContentInterface $entity */
                    // If the link is routed determine whether the user has access unless
                    // they have the 'link to any page' permission.
                    if (!$account->hasPermission('link to any page') && ($url_object = $entity->getUrlObject()) && $url_object->isRouted()) {
                        $link_access = $this->accessManager
                            ->checkNamedRoute($url_object->getRouteName(), $url_object->getRouteParameters(), $account, TRUE);
                        $access = $access->andIf($link_access);
                    }
                    return $access;
                }
            case 'delete':
                return AccessResult::allowedIfHasPermission($account, 'administer menu')->andIf(AccessResult::allowedIf(!$entity->isNew())
                    ->addCacheableDependency($entity));
            default:
                return parent::checkAccess($entity, $operation, $account);
        }
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title 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
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::checkCreateAccess protected function Performs create access checks. 14
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.
MenuLinkContentAccessControlHandler::$accessManager protected property The access manager to check routes by name.
MenuLinkContentAccessControlHandler::checkAccess protected function Performs access checks. Overrides EntityAccessControlHandler::checkAccess
MenuLinkContentAccessControlHandler::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityHandlerInterface::createInstance
MenuLinkContentAccessControlHandler::__construct public function Creates a new MenuLinkContentAccessControlHandler. Overrides EntityAccessControlHandler::__construct
StringTranslationTrait::$stringTranslation protected property The string translation service.
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.