interface RouteEnhancerInterface in Zircon Profile 8

A route enhancer can change the values in the route data arrays

This is useful to provide information to the rest of the routing system that can be inferred from other parameters rather than hardcode that information in every route.

@author David Buchmann

Hierarchy

• interface \Symfony\Cmf\Component\Routing\Enhancer\RouteEnhancerInterface

3 files declare their use of RouteEnhancerInterface

DynamicRouter.php in vendor/symfony-cmf/routing/DynamicRouter.php

LazyRouteEnhancer.php in core/lib/Drupal/Core/Routing/LazyRouteEnhancer.php

Contains \Drupal\Core\Routing\LazyRouteEnhancer.

RouteEnhancerInterface.php in core/lib/Drupal/Core/Routing/Enhancer/RouteEnhancerInterface.php

Contains \Drupal\Core\Routing\Enhancer\RouteEnhancerInterface.

File

vendor/symfony-cmf/routing/Enhancer/RouteEnhancerInterface.php, line 25

Namespace

Symfony\Cmf\Component\Routing\Enhancer

interface RouteEnhancerInterface {

  /**
   * Update the defaults based on its own data and the request.
   *
   * @param array   $defaults the getRouteDefaults array.
   * @param Request $request  the Request instance.
   *
   * @return array the modified defaults. Each enhancer MUST return the
   *               $defaults but may add or remove values.
   */
  public function enhance(array $defaults, Request $request);

}

Members

Name	Modifiers	Type	Description	Overrides
RouteEnhancerInterface::enhance	public	function	Update the defaults based on its own data and the request.	9