fix locale handling in routing

Author: dbu

DependencyInjection/CmfRoutingExtension.php

@@ -83,13 +83,18 @@ private function setupDynamicRouter(array $config, ContainerBuilder $container,
         }
         $container->setParameter($this->getAlias() . '.defined_templates_class', $controllerForTemplates);
         $container->setParameter($this->getAlias() . '.uri_filter_regexp', $config['uri_filter_regexp']);
+        $locales = false;
+        if (isset($config['locales'])) {
+            $locales = $config['locales'];
+            $container->setParameter($this->getAlias() . '.dynamic.locales', $locales);
+        }
 
         $loader->load('routing-dynamic.xml');
 
         $hasProvider = false;
         $hasContentRepository = false;
         if (!empty($config['persistence']['phpcr']['enabled'])) {
-            $this->loadPhpcrProvider($config['persistence']['phpcr'], $loader, $container);
+            $this->loadPhpcrProvider($config['persistence']['phpcr'], $loader, $container, $locales);
             $hasProvider = true;
             $hasContentRepository = true;
         }
@@ -142,7 +147,7 @@ private function setupDynamicRouter(array $config, ContainerBuilder $container,
         }
     }
 
-    public function loadPhpcrProvider($config, XmlFileLoader $loader, ContainerBuilder $container)
+    public function loadPhpcrProvider($config, XmlFileLoader $loader, ContainerBuilder $container, $locales)
     {
         $loader->load('provider-phpcr.xml');
 
@@ -156,9 +161,7 @@ public function loadPhpcrProvider($config, XmlFileLoader $loader, ContainerBuild
         $container->setAlias($this->getAlias() . '.route_provider', $this->getAlias() . '.phpcr_route_provider');
         $container->setAlias($this->getAlias() . '.content_repository', $this->getAlias() . '.phpcr_content_repository');
 
-        if (isset($config['locales']) && $config['locales']) {
-            $container->setParameter($this->getAlias() . '.locales', $config['locales']);
-        } else {
+        if (!$locales) {
             $container->removeDefinition('cmf_routing.phpcrodm_route_locale_listener');
         }
 

Resources/config/provider-phpcr.xml

@@ -32,7 +32,7 @@
 
         <service id="cmf_routing.phpcrodm_route_locale_listener" class="%cmf_routing.phpcrodm_route_locale_listener_class%">
             <argument>%cmf_routing.dynamic.persistence.phpcr.route_basepath%</argument>
-            <argument>%cmf_routing.locales%</argument>
+            <argument>%cmf_routing.dynamic.locales%</argument>
             <tag name="doctrine_phpcr.event_listener" event="postLoad" />
             <tag name="doctrine_phpcr.event_listener" event="postPersist" />
             <tag name="doctrine_phpcr.event_listener" event="postMove" />

Tests/Functional/Routing/DynamicRouterTest.php

@@ -163,6 +163,49 @@ public function testNoMatchingFormat()
         $this->router->matchRequest(Request::create('/format/48.xml'));
     }
 
+    public function testMatchLocale()
+    {
+        $route = new Route;
+        $route->setPosition($this->getDm()->find(null, self::ROUTE_ROOT), 'de');
+        $route->setDefault(RouteObjectInterface::CONTROLLER_NAME, 'testController');
+        $this->getDm()->persist($route);
+        $childroute = new Route;
+        $childroute->setPosition($route, 'testroute');
+        $this->getDm()->persist($childroute);
+        $nolocale = new Route;
+        $nolocale->setPosition($this->getDm()->find(null, self::ROUTE_ROOT), 'es');
+        $nolocale->setDefault(RouteObjectInterface::CONTROLLER_NAME, 'testController');
+        $this->getDm()->persist($nolocale);
+        $this->getDm()->flush();
+
+        $expected = array(
+            '_controller' => 'testController',
+            '_locale' => 'de',
+            '_route' => self::ROUTE_ROOT . '/de'
+        );
+        $this->assertEquals(
+            $expected,
+            $this->router->match('/de')
+        );
+        $expected = array(
+            '_locale' => 'de',
+            '_route' => self::ROUTE_ROOT . '/de/testroute'
+        );
+        $this->assertEquals(
+            $expected,
+            $this->router->match('/de/testroute')
+        );
+        // es is not a configured locale
+        $expected = array(
+            '_controller' => 'testController',
+            '_route' => self::ROUTE_ROOT . '/es'
+        );
+        $this->assertEquals(
+            $expected,
+            $this->router->match('/es')
+        );
+    }
+
     public function testEnhanceControllerByAlias()
     {
         // put a redirect route

Tests/Resources/app/config/cmf_routing.yml

@@ -15,3 +15,6 @@ cmf_routing:
             phpcr:
                 enabled: true
                 route_basepath: /test/routing
+        locales:
+            - en
+            - de