You are here

interface RouteFilterInterface in Zircon Profile 8

Same name in this branch
  1. 8 vendor/symfony-cmf/routing/NestedMatcher/RouteFilterInterface.php \Symfony\Cmf\Component\Routing\NestedMatcher\RouteFilterInterface
  2. 8 core/lib/Drupal/Core/Routing/RouteFilterInterface.php \Drupal\Core\Routing\RouteFilterInterface
Same name and namespace in other branches
  1. 8.0 core/lib/Drupal/Core/Routing/RouteFilterInterface.php \Drupal\Core\Routing\RouteFilterInterface

A route filter service to filter down the collection of route instances.

Hierarchy

Expanded class hierarchy of RouteFilterInterface

All classes that implement RouteFilterInterface

1 file declares its use of RouteFilterInterface
AcceptHeaderMatcher.php in core/modules/system/tests/modules/accept_header_routing_test/src/Routing/AcceptHeaderMatcher.php
Contains \Drupal\accept_header_routing_test\Routing\AcceptHeaderMatcher.

File

core/lib/Drupal/Core/Routing/RouteFilterInterface.php, line 16
Contains \Drupal\Core\Routing\RouteFilterInterface.

Namespace

Drupal\Core\Routing
View source
interface RouteFilterInterface extends BaseRouteFilterInterface {

  /**
   * Determines if the route filter applies to the given route.
   *
   * @param \Symfony\Component\Routing\Route $route
   *  The route to consider attaching to.
   *
   * @return bool
   *   TRUE if the check applies to the passed route, FALSE otherwise.
   */
  public function applies(Route $route);

}

Members

Namesort descending Modifiers Type Description Overrides
RouteFilterInterface::applies public function Determines if the route filter applies to the given route. 3
RouteFilterInterface::filter public function Filters the route collection against a request and returns all matching routes. 4