interface AccessAwareRouterInterface in Zircon Profile 8

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

Hierarchy

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

4 files declare their use of AccessAwareRouterInterface

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

Contains \Drupal\Tests\Core\Routing\AccessAwareRouterTest.

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

Contains \Drupal\Core\EventSubscriber\DefaultExceptionHtmlSubscriber.

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

Contains \Drupal\Core\Path\PathValidator.

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

Contains \Drupal\Core\EventSubscriber\RouteAccessResponseSubscriber.

File

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

Contains \Drupal\Core\Routing\AccessAwareRouterInterface.

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	Overrides UrlMatcherInterface::match	1
AccessAwareRouterInterface::matchRequest	public	function	Overrides RequestMatcherInterface::matchRequest	1
RequestContextAwareInterface::getContext	public	function	Gets the request context.	9
RequestContextAwareInterface::setContext	public	function	Sets the request context.	9
RouterInterface::getRouteCollection	public	function	Gets the RouteCollection instance associated with this Router.	4
UrlGeneratorInterface::ABSOLUTE_PATH		constant	Generates an absolute path, e.g. "/dir/file".
UrlGeneratorInterface::ABSOLUTE_URL		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.	8
UrlGeneratorInterface::NETWORK_PATH		constant	Generates a network path, e.g. "//example.com/dir/file". Such reference reuses the current scheme but specifies the host.
UrlGeneratorInterface::RELATIVE_PATH		constant	Generates a relative path based on the current request path, e.g. "../parent-file".