renaming controller resolver to controller mapper. fix https://github.com/symfony-cmf/ChainRoutingBundle/issues/11

Author: dbu

DoctrineRouter.php

@@ -11,7 +11,7 @@
 use Symfony\Component\Routing\Generator\UrlGenerator;
 use Symfony\Component\Routing\Matcher\UrlMatcher;
 
-use Symfony\Cmf\Component\Routing\Resolver\ControllerResolverInterface;
+use Symfony\Cmf\Component\Routing\Mapper\ControllerMapperInterface;
 
 use Doctrine\Common\Persistence\ManagerRegistry;
 use Doctrine\Common\Persistence\ObjectManager;
@@ -43,19 +43,21 @@ class DoctrineRouter implements RouterInterface
     const ROUTE_NAME_PREFIX = 'cmf_routing_doctrine_route';
 
     /**
-     * @var array of ContentResolverInterface
+     * @var array of ControllerMapperInterface
      */
-    protected $resolvers = array();
+    protected $mappers = array();
     /**
      * The route repository to get routes from
      * @var RouteRepositoryInterface
      */
     protected $routeRepository;
 
     /**
-     * The content repository used to resolve content by it's id
+     * The content repository used to find content by it's id
      * This can be used to specify a parameter content_id when generating urls
      *
+     * This is optional and might not be initialized.
+     *
      * @var  ContentRepositoryInterface
      */
     protected $contentRepository;
@@ -76,7 +78,7 @@ public function __construct(RouteRepositoryInterface $routeRepository)
     }
 
     /**
-     * Set an optional content repository to resolve content ids
+     * Set an optional content repository to find content by ids
      *
      * @param ContentRepositoryInterface $contentRepository
      */
@@ -86,15 +88,15 @@ public function setContentRepository(ContentRepositoryInterface $contentReposito
     }
 
     /**
-     * Add as many resolvers as you want, they are asked for the controller in
+     * Add as many mappers as you want, they are asked for the controller in
      * the order they are added here.
      *
-     * @param ControllerResolverInterface $resolver a helper to resolve the
-     *      controller responsible for the matched url
+     * @param ControllerMapperInterface $mapper a helper to map the request to
+     *      controller name
      */
-    public function addControllerResolver(ControllerResolverInterface $resolver)
+    public function addControllerMapper(ControllerMapperInterface $mapper)
     {
-        $this->resolvers[] = $resolver;
+        $this->mappers[] = $mapper;
     }
 
     /**
@@ -198,17 +200,17 @@ public function match($url)
         $route = $collection->get($defaults['_route']);
 
         if (empty($defaults['_controller'])) {
-            // if content does not provide explicit controller, try to find it with one of the resolvers
+            // if content does not provide explicit controller, try to find it with one of the mappers
             $controller = false;
-            foreach ($this->resolvers as $resolver) {
-                $controller = $resolver->getController($route, $defaults);
+            foreach ($this->mappers as $mapper) {
+                $controller = $mapper->getController($route, $defaults);
                 if ($controller !== false) {
                     break;
                 }
             }
 
             if (false === $controller) {
-                throw new ResourceNotFoundException("The resolver was not able to determine a controller for '$url'");;
+                throw new ResourceNotFoundException("The mapper was not able to determine a controller for '$url'");;
             }
 
             $defaults['_controller'] = $controller;

Resolver/ControllerAliasResolver.php renamed to Mapper/ControllerAliasMapper.php

@@ -1,17 +1,17 @@
 <?php
 
-namespace Symfony\Cmf\Component\Routing\Resolver;
+namespace Symfony\Cmf\Component\Routing\Mapper;
 
 use Symfony\Cmf\Component\Routing\RouteObjectInterface;
 
 /**
  * Decide the controller by a map from alias to controller name injected into
- * the resolver.
+ * the mapper.
  * Only works with route objects that return a 'type' field in the defaults.
  *
  * @author David Buchmann
  */
-class ControllerAliasResolver implements ControllerResolverInterface
+class ControllerAliasMapper implements ControllerMapperInterface
 {
     /**
      * array containing the mapping between phpcr_alias and controller

Resolver/ControllerClassResolver.php renamed to Mapper/ControllerClassMapper.php

@@ -1,19 +1,19 @@
 <?php
 
-namespace Symfony\Cmf\Component\Routing\Resolver;
+namespace Symfony\Cmf\Component\Routing\Mapper;
 
 use Symfony\Cmf\Component\Routing\RouteObjectInterface;
 
 /**
  * Decide the controller by a map from class to controller name injected into
- * the resolver. The comparison is done with instanceof to support proxy
+ * the mapper. The comparison is done with instanceof to support proxy
  * classes and such.
  *
  * Only works with route objects that return a referenced content.
  *
  * @author David Buchmann
  */
-class ControllerClassResolver implements ControllerResolverInterface
+class ControllerClassMapper implements ControllerMapperInterface
 {
     private $controllersByClass;
 

Resolver/ControllerResolverInterface.php renamed to Mapper/ControllerMapperInterface.php

@@ -1,26 +1,26 @@
 <?php
 
-namespace Symfony\Cmf\Component\Routing\Resolver;
+namespace Symfony\Cmf\Component\Routing\Mapper;
 
 use Symfony\Cmf\Component\Routing\RouteObjectInterface;
 
 /**
- * Interface for all controller resolvers that work with the DoctrineRouter
+ * Interface for all controller mappers that work with the DoctrineRouter
  *
  * @author David Buchmann
  */
-interface ControllerResolverInterface
+interface ControllerMapperInterface
 {
     /**
      * Retrieves the right controller for the given route $document.
      *
      * @param RouteObjectInterface $document the document or entity for the route
      * @param array $defaults the getRouteDefaults array which may be altered by
-     *      the resolver
+     *      the mapper
      *
      * @return string the controller to use with this route object including
      *      the action, i.e. symfony_cmf_content.controller:indexAction
-     *      or false if the resolver can not determine the router
+     *      or false if the mapper can not determine the router
      */
     function getController(RouteObjectInterface $document, array &$defaults);
 

Resolver/ExplicitTemplateResolver.php renamed to Mapper/ExplicitTemplateMapper.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Symfony\Cmf\Component\Routing\Resolver;
+namespace Symfony\Cmf\Component\Routing\Mapper;
 
 use Symfony\Cmf\Component\Routing\RouteObjectInterface;
 
@@ -10,7 +10,7 @@
  *
  * @author David Buchmann
  */
-class ExplicitTemplateResolver implements ControllerResolverInterface
+class ExplicitTemplateMapper implements ControllerMapperInterface
 {
     /**
      * the controller name or service name that will accept a content and a
@@ -21,7 +21,7 @@ class ExplicitTemplateResolver implements ControllerResolverInterface
     private $genericController;
 
     /**
-     * Instantiate the template resolver
+     * Instantiate the template mapper
      *
      * @param string $genericController the controller name or service name
      *      that will accept a content and a template

Resolver/TemplateClassResolver.php renamed to Mapper/TemplateClassMapper.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Symfony\Cmf\Component\Routing\Resolver;
+namespace Symfony\Cmf\Component\Routing\Mapper;
 
 use Symfony\Cmf\Component\Routing\RouteObjectInterface;
 
@@ -12,7 +12,7 @@
  *
  * @author David Buchmann
  */
-class TemplateClassResolver implements ControllerResolverInterface
+class TemplateClassMapper implements ControllerMapperInterface
 {
     /**
      * the controller name or service name that will accept a content and a
@@ -30,7 +30,7 @@ class TemplateClassResolver implements ControllerResolverInterface
     private $templatesByClass;
 
     /**
-     * Instantiate the template resolver
+     * Instantiate the template mapper
      *
      * @param string $genericController the controller name or service name
      *      that will accept a content and a template

README.md

@@ -51,7 +51,7 @@ To instantiate a DoctrineRouter, you need an implementation of the
 RouteRepositoryInterface. See the [Symfony2 RoutingExtraBundle](https://github.com/symfony-cmf/RoutingExtraBundle)
 document classes for an example.
 
-You will want to create controller resolvers that decide what controller will
+You will want to create controller mappers that decide what controller will
 be used to handle the request, to avoid hardcoding controller names into your
 content.
 
@@ -62,8 +62,8 @@ The match method of the DoctrineRouter does the following steps
 * Ask the repository for Route documents that could match the requested url
 * Build a route collection and let the UrlMatcher find a matching route
 * If the defaults do not contain the field _controller, loop through the
-    ControllerResolverInterface list to find the controller. If none of the
-    resolver finds a controller, throw a ResourceNotFoundException
+    ControllerMapperInterface list to find the controller. If none of the
+    mapper finds a controller, throw a ResourceNotFoundException
 * If the route implements RouteObjectInterace and returns a non-null content,
     set it in the returned array with key ``_content``.
 
@@ -78,7 +78,7 @@ All routes still need to extend the base class Symfony\Component\Routing\Route
 You can build redirections with a RedirectRouteInterface document. It can
 redirect either to an absolute URI, or to a named route that can be generated by
 any router in the chain or to another Route object in the repository.
-To handle it, you can make ControllerClassResolver map a suitable controller
+To handle it, you can make ControllerClassMapper map a suitable controller
 to Symfony\Cmf\Component\Routing\RedirectRouteInterface
 
 ### Routes and locales
@@ -96,7 +96,7 @@ under the same url is not a good idea.
 
 ### Customize
 
-You can add more ControllerResolverInterface implementations if you have a case
+You can add more ControllerMapperInterface implementations if you have a case
 not handled by the provided ones.
 
 For more specific needs, have a look at DoctrineRouter and see if you want to

RouteObjectInterface.php

@@ -13,7 +13,7 @@
 interface RouteObjectInterface
 {
     /**
-     * Constant for the field that is given to the ControllerAliasResolver.
+     * Constant for the field that is given to the ControllerAliasMapper.
      * The value must be configured in the controllers_by_alias mapping.
      *
      * This is ignored if a _controller default value is provided as well
@@ -28,7 +28,7 @@ interface RouteObjectInterface
 
     /**
      * Get the content document this route entry stands for. If non-null,
-     * the ControllerClassResolver uses it to identify a controller and
+     * the ControllerClassMapper uses it to identify a controller and
      * the content is passed to the controller.
      *
      * If there is no specific content for this url (i.e. its an "application"

Tests/Resolver/ControllerAliasResolverTest.php renamed to Tests/Mapper/ControllerAliasMapperTest.php

@@ -3,35 +3,40 @@
 namespace Symfony\Cmf\Component\Routing\Tests\Controller;
 
 use Symfony\Cmf\Component\Routing\Test\CmfUnitTestCase;
-use Symfony\Cmf\Component\Routing\Resolver\ControllerAliasResolver;
+use Symfony\Cmf\Component\Routing\Mapper\ControllerAliasMapper;
 
-class ControllerAliasResolverTest extends CmfUnitTestCase
+class ControllerAliasMapperTest extends CmfUnitTestCase
 {
+    /**
+     * @var ControllerAliasMapper
+     */
+    private $mapper;
+
     public function setUp()
     {
         $this->document = $this->buildMock('Symfony\\Cmf\\Component\\Routing\\RouteObjectInterface',
                                             array('getRouteContent', 'getRouteDefaults', 'getUrl'));
 
         $mapping = array('static_pages' => 'symfony_cmf_content.controller:indexAction');
 
-        $this->resolver = new ControllerAliasResolver($mapping);
+        $this->mapper = new ControllerAliasMapper($mapping);
     }
 
     public function testControllerFoundInMapping()
     {
         $defaults = array('type' => 'static_pages');
-        $this->assertEquals('symfony_cmf_content.controller:indexAction', $this->resolver->getController($this->document, $defaults));
+        $this->assertEquals('symfony_cmf_content.controller:indexAction', $this->mapper->getController($this->document, $defaults));
     }
 
     public function testControllerNoType()
     {
         $defaults = array();
-        $this->assertEquals(null, $this->resolver->getController($this->document, $defaults));
+        $this->assertEquals(null, $this->mapper->getController($this->document, $defaults));
     }
 
     public function testControllerNotFoundInMapping()
     {
         $defaults = array('type' => 'unknown_route');
-        $this->assertEquals(null, $this->resolver->getController($this->document, $defaults));
+        $this->assertEquals(null, $this->mapper->getController($this->document, $defaults));
     }
 }

Tests/Resolver/ControllerClassResolverTest.php renamed to Tests/Mapper/ControllerClassMapperTest.php

@@ -3,10 +3,15 @@
 namespace Symfony\Cmf\Component\Routing\Tests\Controller;
 
 use Symfony\Cmf\Component\Routing\Test\CmfUnitTestCase;
-use Symfony\Cmf\Component\Routing\Resolver\ControllerClassResolver;
+use Symfony\Cmf\Component\Routing\Mapper\ControllerClassMapper;
 
-class ControllerClassResolverTest extends CmfUnitTestCase
+class ControllerClassMapperTest extends CmfUnitTestCase
 {
+    /**
+     * @var ControllerClassMapper
+     */
+    private $mapper;
+
     public function setUp()
     {
         $this->document = $this->buildMock('Symfony\\Cmf\\Component\\Routing\\RouteObjectInterface',
@@ -15,7 +20,7 @@ public function setUp()
         $mapping = array('Symfony\\Cmf\\Component\\Routing\\Tests\\Controller\\TargetDocument'
                             => 'symfony_cmf_content.controller:indexAction');
 
-        $this->resolver = new ControllerClassResolver($mapping);
+        $this->mapper = new ControllerClassMapper($mapping);
     }
 
     public function testControllerFoundInMapping()
@@ -25,7 +30,7 @@ public function testControllerFoundInMapping()
                 ->will($this->returnValue(new TargetDocument));
 
         $defaults = array();
-        $this->assertEquals('symfony_cmf_content.controller:indexAction', $this->resolver->getController($this->document, $defaults));
+        $this->assertEquals('symfony_cmf_content.controller:indexAction', $this->mapper->getController($this->document, $defaults));
         $this->assertEquals(array(), $defaults);
     }
 
@@ -36,7 +41,7 @@ public function testControllerNotFoundInMapping()
                 ->will($this->returnValue(new UnknownDocument));
 
         $defaults = array();
-        $this->assertEquals(null, $this->resolver->getController($this->document, $defaults));
+        $this->assertEquals(null, $this->mapper->getController($this->document, $defaults));
         $this->assertEquals(array(), $defaults);
     }
 
@@ -47,7 +52,7 @@ public function testControllerNoContent()
             ->will($this->returnValue(null));
 
         $defaults = array();
-        $this->assertEquals(null, $this->resolver->getController($this->document, $defaults));
+        $this->assertEquals(null, $this->mapper->getController($this->document, $defaults));
         $this->assertEquals(array(), $defaults);
     }
 }