interface RouteFilterInterface in Drupal 8

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

Hierarchy

• interface \Drupal\Core\Routing\FilterInterface extends \Symfony\Cmf\Component\Routing\NestedMatcher\RouteFilterInterface
  • interface \Drupal\Core\Routing\RouteFilterInterface

Deprecated

in drupal:8.4.0 and is removed from drupal:9.0.0. Instead, you should use \Drupal\Core\Routing\FilterInterface. See https://www.drupal.org/node/2894934

File

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

Namespace

Drupal\Core\Routing

interface RouteFilterInterface extends FilterInterface {

  /**
   * 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

Name	Modifiers	Type	Description	Overrides
RouteFilterInterface::applies	public	function	Determines if the route filter applies to the given route.