class MenuAccessControlHandler

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

Defines the access control handler for the menu entity type.

Hierarchy

Expanded class hierarchy of MenuAccessControlHandler

See also

\Drupal\system\Entity\Menu

1 file declares its use of MenuAccessControlHandler
Menu.php in core/modules/system/src/Entity/Menu.php

File

core/modules/system/src/MenuAccessControlHandler.php, line 15

Namespace

Drupal\system
View source 
class MenuAccessControlHandler extends EntityAccessControlHandler {
    
    /**
     * {@inheritdoc}
     */
    protected $viewLabelOperation = TRUE;
    
    /**
     * {@inheritdoc}
     */
    protected function checkAccess(EntityInterface $entity, $operation, AccountInterface $account) {
        // There are no restrictions on viewing the label of a menu.
        if ($operation === 'view label') {
            return AccessResult::allowed();
        }
        elseif ($operation === 'delete') {
            if ($entity->isLocked()) {
                return AccessResult::forbidden('The Menu config entity is locked.')->addCacheableDependency($entity);
            }
            else {
                return parent::checkAccess($entity, $operation, $account)->addCacheableDependency($entity);
            }
        }
        return parent::checkAccess($entity, $operation, $account);
    }

}

Members

Title 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::access public function 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 Overrides EntityAccessControlHandlerInterface::createAccess 1
EntityAccessControlHandler::fieldAccess public function 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 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. 8
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.
MenuAccessControlHandler::$viewLabelOperation protected property Overrides EntityAccessControlHandler::$viewLabelOperation
MenuAccessControlHandler::checkAccess protected function Overrides EntityAccessControlHandler::checkAccess
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.