class SearchPageAccessControlHandler

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

Defines the access control handler for the search page entity type.

Hierarchy

Expanded class hierarchy of SearchPageAccessControlHandler

See also

\Drupal\search\Entity\SearchPage

File

core/modules/search/src/SearchPageAccessControlHandler.php, line 16

Namespace

Drupal\search
View source 
class SearchPageAccessControlHandler extends EntityAccessControlHandler {
    
    /**
     * {@inheritdoc}
     */
    protected function checkAccess(EntityInterface $entity, $operation, AccountInterface $account) {
        
        /** @var \Drupal\search\SearchPageInterface $entity */
        if (in_array($operation, [
            'delete',
            'disable',
        ])) {
            if ($entity->isDefaultSearch()) {
                return AccessResult::forbidden()->addCacheableDependency($entity);
            }
            else {
                return parent::checkAccess($entity, $operation, $account)->addCacheableDependency($entity);
            }
        }
        if ($operation == 'view') {
            if (!$entity->status()) {
                return AccessResult::forbidden()->addCacheableDependency($entity);
            }
            $plugin = $entity->getPlugin();
            if ($plugin instanceof AccessibleInterface) {
                return $plugin->access($operation, $account, TRUE)
                    ->addCacheableDependency($entity);
            }
            return AccessResult::allowed()->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::$viewLabelOperation protected property Allows to grant access to just the labels. 7
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.
SearchPageAccessControlHandler::checkAccess protected function Performs access checks. 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.