annotate vendor/symfony-cmf/routing/Enhancer/RouteEnhancerInterface.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 4c8ae668cc8c
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 /*
Chris@0 4 * This file is part of the Symfony CMF package.
Chris@0 5 *
Chris@0 6 * (c) 2011-2015 Symfony CMF
Chris@0 7 *
Chris@0 8 * For the full copyright and license information, please view the LICENSE
Chris@0 9 * file that was distributed with this source code.
Chris@0 10 */
Chris@0 11
Chris@0 12 namespace Symfony\Cmf\Component\Routing\Enhancer;
Chris@0 13
Chris@0 14 use Symfony\Component\HttpFoundation\Request;
Chris@0 15
Chris@0 16 /**
Chris@0 17 * A route enhancer can change the values in the route data arrays.
Chris@0 18 *
Chris@0 19 * This is useful to provide information to the rest of the routing system
Chris@0 20 * that can be inferred from other parameters rather than hardcode that
Chris@0 21 * information in every route.
Chris@0 22 *
Chris@0 23 * @author David Buchmann
Chris@0 24 */
Chris@0 25 interface RouteEnhancerInterface
Chris@0 26 {
Chris@0 27 /**
Chris@0 28 * Update the defaults based on its own data and the request.
Chris@0 29 *
Chris@0 30 * @param array $defaults the getRouteDefaults array.
Chris@0 31 * @param Request $request the Request instance.
Chris@0 32 *
Chris@0 33 * @return array the modified defaults. Each enhancer MUST return the
Chris@0 34 * $defaults but may add or remove values.
Chris@0 35 */
Chris@0 36 public function enhance(array $defaults, Request $request);
Chris@0 37 }