interface AccessAwareRouterInterface in Drupal 9

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

Hierarchy

• interface \Drupal\Core\Routing\AccessAwareRouterInterface extends \Symfony\Component\Routing\RouterInterface \Symfony\Component\Routing\Matcher\RequestMatcherInterface

6 files declare their use of AccessAwareRouterInterface

AccessAwareRouterTest.php in core/tests/Drupal/Tests/Core/Routing/AccessAwareRouterTest.php

CustomPageExceptionHtmlSubscriber.php in core/lib/Drupal/Core/EventSubscriber/CustomPageExceptionHtmlSubscriber.php

CustomPageExceptionHtmlSubscriberTest.php in core/tests/Drupal/Tests/Core/EventSubscriber/CustomPageExceptionHtmlSubscriberTest.php

EntityResource.php in core/modules/rest/src/Plugin/rest/resource/EntityResource.php

PathValidator.php in core/lib/Drupal/Core/Path/PathValidator.php

... See full list

File

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

Namespace

Drupal\Core\Routing

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);

  /**
   * {@inheritdoc}
   *
   * @throws \Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException
   *   Thrown when $access_check is enabled and access checking failed.
   */
  public function match($pathinfo);

}

Members

Name	Modifiers	Type	Description	Overrides
AccessAwareRouterInterface::ACCESS_RESULT		constant	Attribute name of the access result for the request..
AccessAwareRouterInterface::match	public	function		1
AccessAwareRouterInterface::matchRequest	public	function		1