interface RouteEnhancerInterface

A route enhance service to determine route enhance rules.

Hierarchy

  • interface \Drupal\Core\Routing\EnhancerInterface extends \Symfony\Cmf\Component\Routing\Enhancer\RouteEnhancerInterface

Expanded class hierarchy of RouteEnhancerInterface

All classes that implement RouteEnhancerInterface

Deprecated

in drupal:8.4.0 and is removed from drupal:9.0.0. Instead, you should use \Drupal\Core\Routing\EnhancerInterface. See https://www.drupal.org/node/2894934 Part of the deprecation means that applies() is now called on runtime instead of compile time.

1 file declares its use of RouteEnhancerInterface
Router.php in core/lib/Drupal/Core/Routing/Router.php

File

core/lib/Drupal/Core/Routing/Enhancer/RouteEnhancerInterface.php, line 19

Namespace

Drupal\Core\Routing\Enhancer
View source 
interface RouteEnhancerInterface extends EnhancerInterface {
    
    /**
     * Declares if the route enhancer 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

Title Modifiers Object type Summary
RouteEnhancerInterface::applies public function Declares if the route enhancer applies to the given route.

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