Merge pull request symfony#43 from symfony-cmf/route-name

route name is in _route now, object in _route_object

Author: Crell

NestedMatcher/ConfigurableUrlMatcher.php

@@ -36,17 +36,19 @@ public function finalMatch(RouteCollection $collection, Request $request)
         $attributes = $matcher->match($request->getPathInfo());
 
         // cleanup route attributes
-        if (! isset($attributes['_route']) || ! $attributes['_route'] instanceof Route) {
-            $name = $attributes['_route'];
-            $route = $collection->get($attributes['_route']);
-            $attributes['_route'] = $route;
+        if (! isset($attributes[RouteObjectInterface::ROUTE_OBJECT])
+            || ! $attributes[RouteObjectInterface::ROUTE_OBJECT] instanceof Route
+        ) {
+            $name = $attributes['_route']; // this is the field coming from symfony core
+            $route = $collection->get($name);
+            $attributes[RouteObjectInterface::ROUTE_OBJECT] = $route;
 
             if ($route instanceof RouteObjectInterface && is_string($route->getRouteKey())) {
                 $name = $route->getRouteKey();
             }
 
-            if (empty($attributes['_route_name']) && is_string($name)) {
-                $attributes['_route_name'] = $name;
+            if (is_string($name)) {
+                $attributes[RouteObjectInterface::ROUTE_NAME] = $name;
             }
         }
 

NestedMatcher/UrlMatcher.php

@@ -39,8 +39,8 @@ protected function getAttributes(Route $route, $name, array $attributes)
         if ($route instanceof RouteObjectInterface && is_string($route->getRouteKey())) {
             $name = $route->getRouteKey();
         }
-        $attributes['_route_name'] = $name;
-        $attributes['_route'] = $route;
+        $attributes[RouteObjectInterface::ROUTE_NAME] = $name;
+        $attributes[RouteObjectInterface::ROUTE_OBJECT] = $route;
         return $this->mergeDefaults($attributes, $route->getDefaults());
     }
 }

RouteObjectInterface.php

@@ -16,6 +16,16 @@
  */
 interface RouteObjectInterface
 {
+    /**
+     * Field name that will hold the route name that was matched.
+     */
+    const ROUTE_NAME = '_route';
+
+    /**
+     * Field name of the route object that was matched.
+     */
+    const ROUTE_OBJECT = '_route_object';
+
     /**
      * Constant for the field that is given to the ControllerAliasMapper.
      * The value must be configured in the controllers_by_alias mapping.

Tests/Enhancer/RouteContentEnhancerTest.php

@@ -5,6 +5,7 @@
 use Symfony\Component\HttpFoundation\Request;
 
 use Symfony\Cmf\Component\Routing\Enhancer\RouteContentEnhancer;
+use Symfony\Cmf\Component\Routing\RouteObjectInterface;
 
 use Symfony\Cmf\Component\Routing\Test\CmfUnitTestCase;
 
@@ -22,7 +23,7 @@ public function setUp()
         $this->document = $this->buildMock('Symfony\\Cmf\\Component\\Routing\\Tests\\Enhancer\\RouteObject',
                                             array('getRouteContent', 'getRouteDefaults', 'getUrl'));
 
-        $this->mapper = new RouteContentEnhancer('_route', '_content');
+        $this->mapper = new RouteContentEnhancer(RouteObjectInterface::ROUTE_OBJECT, '_content');
 
         $this->request = Request::create('/test');
     }
@@ -34,8 +35,8 @@ public function testContent()
             ->method('getRouteContent')
             ->will($this->returnValue($targetDocument));
 
-        $defaults = array('_route' => $this->document);
-        $expected = array('_route' => $this->document, '_content' => $targetDocument);
+        $defaults = array(RouteObjectInterface::ROUTE_OBJECT => $this->document);
+        $expected = array(RouteObjectInterface::ROUTE_OBJECT => $this->document, '_content' => $targetDocument);
 
         $this->assertEquals($expected, $this->mapper->enhance($defaults, $this->request));
     }
@@ -47,7 +48,7 @@ public function testFieldAlreadyThere()
             ->method('getRouteContent')
         ;
 
-        $defaults = array('_route' => $this->document, '_content' => 'foo');
+        $defaults = array(RouteObjectInterface::ROUTE_OBJECT => $this->document, '_content' => 'foo');
 
         $this->assertEquals($defaults, $this->mapper->enhance($defaults, $this->request));
     }
@@ -58,13 +59,13 @@ public function testNoContent()
             ->method('getRouteContent')
             ->will($this->returnValue(null));
 
-        $defaults = array('_route' => $this->document);
+        $defaults = array(RouteObjectInterface::ROUTE_OBJECT => $this->document);
         $this->assertEquals($defaults, $this->mapper->enhance($defaults, $this->request));
     }
 
     public function testNoCmfRoute()
     {
-        $defaults = array('_route' => $this->buildMock('Symfony\\Component\\Routing\\Route'));
+        $defaults = array(RouteObjectInterface::ROUTE_OBJECT => $this->buildMock('Symfony\\Component\\Routing\\Route'));
         $this->assertEquals($defaults, $this->mapper->enhance($defaults, $this->request));
     }
 }

Tests/NestedMatcher/ConfigurableUrlMatcherTest.php

@@ -51,7 +51,12 @@ public function testMatch()
             ->method('getDefaults')
             ->will($this->returnValue(array('foo' => 'bar')))
         ;
+        $this->routeDocument->expects($this->any())
+            ->method('getRouteKey')
+            ->will($this->returnValue('/routes/company/more'))
+        ;
 
+        // add some other routes to the collection
         $mockCompiled = $this->buildMock('Symfony\\Component\\Routing\\CompiledRoute');
         $mockCompiled->expects($this->any())
             ->method('getStaticPrefix')
@@ -62,16 +67,18 @@ public function testMatch()
             ->method('compile')
             ->will($this->returnValue($mockCompiled))
         ;
+
         $routeCollection = new RouteCollection();
         $routeCollection->add('some', $mockRoute);
         $routeCollection->add('_company_more', $this->routeDocument);
         $routeCollection->add('other', $mockRoute);
 
         $results = $this->matcher->finalMatch($routeCollection, $this->request);
 
+        // the matched route returns a key
         $expected = array(
-            '_route_name' => '_company_more',
-            '_route' => $this->routeDocument,
+            RouteObjectInterface::ROUTE_NAME => '/routes/company/more',
+            RouteObjectInterface::ROUTE_OBJECT => $this->routeDocument,
             'foo' => 'bar',
         );
 
@@ -118,9 +125,10 @@ public function testMatchNoRouteObject()
 
         $results = $this->matcher->finalMatch($routeCollection, $this->request);
 
+        // the matched route does not return a key
         $expected = array(
-            '_route_name' => '_company_more',
-            '_route' => $this->routeDocument,
+            RouteObjectInterface::ROUTE_NAME => '_company_more',
+            RouteObjectInterface::ROUTE_OBJECT => $this->routeDocument,
             'foo' => 'bar',
         );
 

Tests/NestedMatcher/UrlMatcherTest.php

@@ -89,8 +89,8 @@ public function doTestMatchRouteKey($routeKey)
         $results = $this->matcher->finalMatch($routeCollection, $this->request);
 
         $expected = array(
-            '_route_name' => ($routeKey) ? $routeKey : '_company_more',
-            '_route' => $this->routeDocument,
+            RouteObjectInterface::ROUTE_NAME => ($routeKey) ? $routeKey : '_company_more',
+            RouteObjectInterface::ROUTE_OBJECT => $this->routeDocument,
             'foo' => 'bar',
         );
 
@@ -138,8 +138,8 @@ public function testMatchNoRouteObject()
         $results = $this->matcher->finalMatch($routeCollection, $this->request);
 
         $expected = array(
-            '_route_name' => '_company_more',
-            '_route' => $this->routeDocument,
+            RouteObjectInterface::ROUTE_NAME => '_company_more',
+            RouteObjectInterface::ROUTE_OBJECT => $this->routeDocument,
             'foo' => 'bar',
         );