Merge pull request symfony#44 from symfony-cmf/safe-generator

add an interface for the generator to know if it has the supports method

Author: dbu

ChainRouter.php

@@ -135,7 +135,7 @@ public function match($url)
     {
         $methodNotAllowed = null;
 
-        /** @var $router ChainedRouterInterface */
+        /** @var $router RouterInterface */
         foreach ($this->all() as $router) {
             try {
                 return $router->match($url);
@@ -196,13 +196,13 @@ public function matchRequest(Request $request)
      */
     public function generate($name, $parameters = array(), $absolute = false)
     {
-        /** @var $router ChainedRouterInterface */
+        /** @var $router RouterInterface */
         foreach ($this->all() as $router) {
 
             // if $name and $router does not implement ChainedRouterInterface and $name is not a string, continue
             // if $name and $router does not implement ChainedRouterInterface and $name is string but does not match a default Symfony2 route name, continue
             if ($name && !$router instanceof ChainedRouterInterface) {
-                if (!is_string($name) || !preg_match('/^[a-z0-9A-Z_.]+$/', $name)) {
+                if (!is_string($name) || !preg_match(VersatileGeneratorInterface::CORE_NAME_PATTERN, $name)) {
                     continue;
                 }
             }

ChainedRouterInterface.php

@@ -5,21 +5,9 @@
 use Symfony\Component\Routing\RouterInterface;
 
 /**
- * Use this interface on custom routers that can handle non-string route
- * "names".
+ * Interface to combine the VersatileGeneratorInterface with the RouterInterface
  */
-interface ChainedRouterInterface extends RouterInterface
+interface ChainedRouterInterface extends RouterInterface, VersatileGeneratorInterface
 {
-    /**
-     * Whether the router supports the thing in $name to generate a route.
-     *
-     * This check does not need to look if the specific instance can be
-     * resolved to a route, only whether the router can generate routes from
-     * objects of this class.
-
-     * @param mixed $name The route name or route object
-     *
-     * @return bool
-     */
-    public function supports($name);
+    // nothing new to add
 }

DynamicRouter.php

@@ -18,7 +18,7 @@
  * A flexible router accepting matcher and generator through injection and
  * using the RouteEnhancer concept to generate additional data on the routes.
  *
- * @author Crell
+ * @author Larry Garfield
  * @author David Buchmann
  */
 class DynamicRouter implements RouterInterface, RequestMatcherInterface, ChainedRouterInterface
@@ -130,14 +130,18 @@ public function generate($name, $parameters = array(), $absolute = false)
     }
 
     /**
-     * Support any string as route name
+     * Delegate to our generator
      *
      * {@inheritDoc}
      */
     public function supports($name)
     {
-        // TODO: check $this->generator instanceof VersatileGeneratorInterface
-        return $this->generator->supports($name);
+        if ($this->generator instanceof VersatileGeneratorInterface) {
+
+            return $this->generator->supports($name);
+        }
+
+        return (!is_string($name) || !preg_match(VersatileGeneratorInterface::CORE_NAME_PATTERN, $name));
     }
 
     /**

ProviderBasedGenerator.php

@@ -16,7 +16,7 @@
  *
  * @author Larry Garfield
  */
-class ProviderBasedGenerator extends UrlGenerator
+class ProviderBasedGenerator extends UrlGenerator implements VersatileGeneratorInterface
 {
     /**
      * The route provider for this generator.

Tests/Routing/DynamicRouterTest.php

@@ -29,7 +29,7 @@ public function setUp()
         $this->routeDocument = $this->buildMock('Symfony\\Cmf\\Component\\Routing\\Tests\\Routing\\RouteMock', array('getDefaults'));
 
         $this->matcher = $this->buildMock('Symfony\\Component\\Routing\\Matcher\\UrlMatcherInterface');
-        $this->generator = $this->buildMock('Symfony\\Component\\Routing\\Generator\\UrlGeneratorInterface', array('supports', 'generate', 'setContext', 'getContext'));
+        $this->generator = $this->buildMock('Symfony\\Cmf\\Component\\Routing\\VersatileGeneratorInterface', array('supports', 'generate', 'setContext', 'getContext'));
         $this->enhancer = $this->buildMock('Symfony\\Cmf\\Component\\Routing\\Enhancer\\RouteEnhancerInterface', array('enhance'));
 
         $this->context = $this->buildMock('Symfony\\Component\\Routing\\RequestContext');

VersatileGeneratorInterface.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Symfony\Cmf\Component\Routing;
+
+use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
+
+/**
+ * This generator is able to handle more than string route names as symfony
+ * core supports them.
+ */
+interface VersatileGeneratorInterface extends UrlGeneratorInterface
+{
+    /**
+     * If $name preg_match this pattern, the name is valid for symfony core
+     * compatible generators.
+     */
+    const CORE_NAME_PATTERN = '/^[a-z0-9A-Z_.]+$/';
+
+    /**
+     * Whether this generator supports the supplied $name.
+     *
+     * This check does not need to look if the specific instance can be
+     * resolved to a route, only whether the router can generate routes from
+     * objects of this class.
+     *
+     * @param mixed $name The route "name" which may also be an object or anything
+     *
+     * @return bool
+     */
+    public function supports($name);
+}
+