add constant for controller and use it where applicable. fix symfony#7

dbu · dbu · commit ecfd6d759c6f · 2012-07-09T22:28:48.000+02:00
diff --git a/DynamicRouter.php b/DynamicRouter.php
@@ -170,8 +170,8 @@ public function getRouteCollection()
      * Returns an array of parameter like this
      *
      * array(
-     *   "_controller" => "NameSpace\Controller::indexAction",
-     *   "_content" => $document,
+     *   RouteObjectInterface::CONTROLLER_NAME => "NameSpace\Controller::indexAction",
+     *   RouteObjectInterface::CONTENT_OBJECT => $document,
      * )
      *
      * The controller can be either the fully qualified class name or the
@@ -184,7 +184,8 @@ public function getRouteCollection()
      * @return array as described above
      *
      * @throws ResourceNotFoundException If the requested url does not exist in the ODM
-     * @throws MethodNotAllowedException If the resource was found but the request method is not allowed
+     * @throws \Symfony\Component\Routing\Exception\MethodNotAllowedException
+     *      If the resource was found but the request method is not allowed
      */
     public function match($url)
     {
@@ -200,7 +201,7 @@ public function match($url)
 
         $route = $collection->get($defaults['_route']);
 
-        if (empty($defaults['_controller'])) {
+        if (empty($defaults[RouteObjectInterface::CONTROLLER_NAME])) {
             // if content does not provide explicit controller, try to find it with one of the mappers
             $controller = false;
             foreach ($this->mappers as $mapper) {
@@ -214,7 +215,7 @@ public function match($url)
                 throw new ResourceNotFoundException("The mapper was not able to determine a controller for '$url'");;
             }
 
-            $defaults['_controller'] = $controller;
+            $defaults[RouteObjectInterface::CONTROLLER_NAME] = $controller;
         }
 
         if ($route instanceof RouteObjectInterface && $content = $route->getRouteContent()) {
@@ -230,7 +231,7 @@ public function match($url)
      *
      * @param RouteCollection $collection collection of routes for the current request
      *
-     * @return UrlMatcherInterface the url matcher instance
+     * @return \Symfony\Component\Routing\Matcher\UrlMatcherInterface the url matcher instance
      */
     public function getMatcher(RouteCollection $collection)
     {
diff --git a/RouteObjectInterface.php b/RouteObjectInterface.php
@@ -22,6 +22,11 @@ interface RouteObjectInterface
      */
     const CONTROLLER_ALIAS = '_controller_alias';
 
+    /**
+     * Field name for an explicit controller name to be used with this route
+     */
+    const CONTROLLER_NAME = '_controller';
+
     /**
      * Field name for an explicit template to be used with this route.
      * i.e. SymfonyCmfContentBundle:StaticContent:index.html.twig
diff --git a/Tests/Routing/DynamicRouterTest.php b/Tests/Routing/DynamicRouterTest.php
@@ -4,6 +4,7 @@
 
 use Symfony\Component\Routing\RouteCollection;
 use Symfony\Cmf\Component\Routing\RouteRepositoryInterface;
+use Symfony\Cmf\Component\Routing\RouteObjectInterface;
 use Symfony\Component\Routing\Route;
 
 use Symfony\Cmf\Component\Routing\Test\CmfUnitTestCase;
@@ -237,10 +238,10 @@ public function testMatch()
         $results = $router->match($url_alias);
 
         $expected = array(
-            '_controller' => 'NameSpace\\Controller::action',
+            RouteObjectInterface::CONTROLLER_NAME => 'NameSpace\\Controller::action',
             '_route' => DynamicRouter::ROUTE_NAME_PREFIX.'_company_more',
             'path' => $url_alias,
-            '_content' => $this->contentDocument,
+            RouteObjectInterface::CONTENT_OBJECT => $this->contentDocument,
         );
 
         $this->assertEquals($expected, $results);
@@ -278,7 +279,7 @@ public function testNoReferenceMatch()
         $router->addControllerMapper($this->mapper);
 
         $expected = array(
-            '_controller' => 'NameSpace\\Controller::action',
+            RouteObjectInterface::CONTROLLER_NAME => 'NameSpace\\Controller::action',
             '_route' => DynamicRouter::ROUTE_NAME_PREFIX.'_company_more_no_reference',
             'path' => $url_alias,
             'type' => 'found',

Original file line number	Diff line number	Diff line change
`@@ -170,8 +170,8 @@ public function getRouteCollection()`
`170`	`170`	`* Returns an array of parameter like this`
`171`	`171`	`*`
`172`	`172`	`* array(`
`173`		`- * "_controller" => "NameSpace\Controller::indexAction",`
`174`		`- * "_content" => $document,`
	`173`	`+ * RouteObjectInterface::CONTROLLER_NAME => "NameSpace\Controller::indexAction",`
	`174`	`+ * RouteObjectInterface::CONTENT_OBJECT => $document,`
`175`	`175`	`* )`
`176`	`176`	`*`
`177`	`177`	`* The controller can be either the fully qualified class name or the`
`@@ -184,7 +184,8 @@ public function getRouteCollection()`
`184`	`184`	`* @return array as described above`
`185`	`185`	`*`
`186`	`186`	`* @throws ResourceNotFoundException If the requested url does not exist in the ODM`
`187`		`- * @throws MethodNotAllowedException If the resource was found but the request method is not allowed`
	`187`	`+ * @throws \Symfony\Component\Routing\Exception\MethodNotAllowedException`
	`188`	`+ * If the resource was found but the request method is not allowed`
`188`	`189`	`*/`
`189`	`190`	`public function match($url)`
`190`	`191`	`{`
`@@ -200,7 +201,7 @@ public function match($url)`
`200`	`201`
`201`	`202`	`$route = $collection->get($defaults['_route']);`
`202`	`203`
`203`		`- if (empty($defaults['_controller'])) {`
	`204`	`+ if (empty($defaults[RouteObjectInterface::CONTROLLER_NAME])) {`
`204`	`205`	`// if content does not provide explicit controller, try to find it with one of the mappers`
`205`	`206`	`$controller = false;`
`206`	`207`	`foreach ($this->mappers as $mapper) {`
`@@ -214,7 +215,7 @@ public function match($url)`
`214`	`215`	`throw new ResourceNotFoundException("The mapper was not able to determine a controller for '$url'");;`
`215`	`216`	`}`
`216`	`217`
`217`		`- $defaults['_controller'] = $controller;`
	`218`	`+ $defaults[RouteObjectInterface::CONTROLLER_NAME] = $controller;`
`218`	`219`	`}`
`219`	`220`
`220`	`221`	`if ($route instanceof RouteObjectInterface && $content = $route->getRouteContent()) {`
`@@ -230,7 +231,7 @@ public function match($url)`
`230`	`231`	`*`
`231`	`232`	`* @param RouteCollection $collection collection of routes for the current request`
`232`	`233`	`*`
`233`		`- * @return UrlMatcherInterface the url matcher instance`
	`234`	`+ * @return \Symfony\Component\Routing\Matcher\UrlMatcherInterface the url matcher instance`
`234`	`235`	`*/`
`235`	`236`	`public function getMatcher(RouteCollection $collection)`
`236`	`237`	`{`