AccessAwareRouterInterface.php

Same filename in other branches
  1. 8.9.x core/lib/Drupal/Core/Routing/AccessAwareRouterInterface.php
  2. 10 core/lib/Drupal/Core/Routing/AccessAwareRouterInterface.php
  3. 11.x core/lib/Drupal/Core/Routing/AccessAwareRouterInterface.php

Namespace

Drupal\Core\Routing

File

core/lib/Drupal/Core/Routing/AccessAwareRouterInterface.php

View source
<?php

namespace Drupal\Core\Routing;

use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Routing\Matcher\RequestMatcherInterface;
use Symfony\Component\Routing\RouterInterface;

/**
 * Interface for a router class for Drupal with access check and upcasting.
 */
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;

}

Interfaces

Title Deprecated Summary
AccessAwareRouterInterface Interface for a router class for Drupal with access check and upcasting.

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