interface AccessAwareRouterInterface

Interface for a router class for Drupal with access check and upcasting.

Hierarchy

  • interface \Symfony\Component\Routing\Matcher\RequestMatcherInterface; interface \Symfony\Component\Routing\RouterInterface extends \Symfony\Component\Routing\Matcher\UrlMatcherInterface \Symfony\Component\Routing\Generator\UrlGeneratorInterface
    • interface \Drupal\Core\Routing\AccessAwareRouterInterface extends \Symfony\Component\Routing\RouterInterface \Symfony\Component\Routing\Matcher\RequestMatcherInterface

Expanded class hierarchy of AccessAwareRouterInterface

All classes that implement AccessAwareRouterInterface

4 files declare their use of AccessAwareRouterInterface
CustomPageExceptionHtmlSubscriber.php in core/lib/Drupal/Core/EventSubscriber/CustomPageExceptionHtmlSubscriber.php
EntityResource.php in core/modules/rest/src/Plugin/rest/resource/EntityResource.php
PathValidator.php in core/lib/Drupal/Core/Path/PathValidator.php
RouteAccessResponseSubscriber.php in core/lib/Drupal/Core/EventSubscriber/RouteAccessResponseSubscriber.php

File

core/lib/Drupal/Core/Routing/AccessAwareRouterInterface.php, line 12

Namespace

Drupal\Core\Routing
View source 
interface AccessAwareRouterInterface extends RouterInterface, RequestMatcherInterface {
    
    /**
     * Attribute name of the access result for the request..
     */
    const ACCESS_RESULT = '_access_result';
    
    /**
     * {@inheritdoc}
     *
     * @throws \Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException
     *   Thrown when access checking failed.
     */
    public function matchRequest(Request $request) : array;
    
    /**
     * {@inheritdoc}
     *
     * @throws \Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException
     *   Thrown when $access_check is enabled and access checking failed.
     */
    public function match($pathinfo) : array;

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
AccessAwareRouterInterface::ACCESS_RESULT constant Attribute name of the access result for the request..
AccessAwareRouterInterface::match public function Overrides UrlMatcherInterface::match 1
AccessAwareRouterInterface::matchRequest public function Overrides RequestMatcherInterface::matchRequest 1
RequestContextAwareInterface::getContext public function Gets the request context. 6
RequestContextAwareInterface::setContext public function Sets the request context. 6
RouterInterface::getRouteCollection public function Gets the RouteCollection instance associated with this Router. 3
UrlGeneratorInterface::ABSOLUTE_PATH public constant Generates an absolute path, e.g. "/dir/file".
UrlGeneratorInterface::ABSOLUTE_URL public constant Generates an absolute URL, e.g. "http://example.com/dir/file".
UrlGeneratorInterface::generate public function Generates a URL or path for a specific route based on the given parameters. 6
UrlGeneratorInterface::NETWORK_PATH public constant Generates a network path, e.g. "//example.com/dir/file".
Such reference reuses the current scheme but specifies the host.
UrlGeneratorInterface::RELATIVE_PATH public constant Generates a relative path based on the current request path, e.g. "../parent-file".