Version 1

[yaffs-website] / vendor / symfony-cmf / routing / Enhancer / RouteEnhancerInterface.php

diff --git a/vendor/symfony-cmf/routing/Enhancer/RouteEnhancerInterface.php b/vendor/symfony-cmf/routing/Enhancer/RouteEnhancerInterface.php
new file mode 100644 (file)
index 0000000..fa4640d
--- /dev/null
+++ b/vendor/symfony-cmf/routing/Enhancer/RouteEnhancerInterface.php
@@ -0,0 +1,37 @@
+<?php
+
+/*
+ * This file is part of the Symfony CMF package.
+ *
+ * (c) 2011-2015 Symfony CMF
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Cmf\Component\Routing\Enhancer;
+
+use Symfony\Component\HttpFoundation\Request;
+
+/**
+ * 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
+ */
+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);
+}