interface AccessCheckInterface

Same name in other branches
  1. 9 core/lib/Drupal/Core/Access/AccessCheckInterface.php \Drupal\Core\Access\AccessCheckInterface
  2. 8.9.x core/lib/Drupal/Core/Access/AccessCheckInterface.php \Drupal\Core\Access\AccessCheckInterface
  3. 11.x core/lib/Drupal/Core/Access/AccessCheckInterface.php \Drupal\Core\Access\AccessCheckInterface

An access check service determines access rules for particular routes.

Hierarchy

Expanded class hierarchy of AccessCheckInterface

All classes that implement AccessCheckInterface

2 files declare their use of AccessCheckInterface
AccessManagerTest.php in core/tests/Drupal/Tests/Core/Access/AccessManagerTest.php
RegisterAccessChecksPass.php in core/lib/Drupal/Core/DependencyInjection/Compiler/RegisterAccessChecksPass.php

File

core/lib/Drupal/Core/Access/AccessCheckInterface.php, line 11

Namespace

Drupal\Core\Access
View source 
interface AccessCheckInterface extends RoutingAccessInterface {
    
    /**
     * Declares whether the access check applies to a specific route or not.
     *
     * @param \Symfony\Component\Routing\Route $route
     *   The route to consider attaching to.
     *
     * @return bool
     *   TRUE if this access checker applies to this route.
     */
    public function applies(Route $route);

}

Members

Title Modifiers Object type Summary Overrides
AccessCheckInterface::applies public function Declares whether the access check applies to a specific route or not. 1

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