[Routing] Allow to set name prefixes from the configuration

Author: sroze

src/Symfony/Component/Routing/Loader/Configurator/Traits/RouteTrait.php

@@ -124,4 +124,14 @@ final public function controller($controller)
 
         return $this;
     }
+
+    /**
+     * Adds a prefix to the name of all the routes within the collection.
+     */
+    final public function addNamePrefix(string $prefix): self
+    {
+        $this->route->addNamePrefix($prefix);
+
+        return $this;
+    }
 }

src/Symfony/Component/Routing/Loader/XmlFileLoader.php

@@ -165,6 +165,10 @@ protected function parseImport(RouteCollection $collection, \DOMElement $node, $
         $subCollection->addRequirements($requirements);
         $subCollection->addOptions($options);
 
+        if ($namePrefix = $node->getAttribute('name-prefix')) {
+            $subCollection->addNamePrefix($namePrefix);
+        }
+
         $collection->addCollection($subCollection);
     }
 

src/Symfony/Component/Routing/Loader/YamlFileLoader.php

@@ -27,7 +27,7 @@
 class YamlFileLoader extends FileLoader
 {
     private static $availableKeys = array(
-        'resource', 'type', 'prefix', 'path', 'host', 'schemes', 'methods', 'defaults', 'requirements', 'options', 'condition', 'controller',
+        'resource', 'type', 'prefix', 'path', 'host', 'schemes', 'methods', 'defaults', 'requirements', 'options', 'condition', 'controller', 'name_prefix',
     );
     private $yamlParser;
 
@@ -169,6 +169,10 @@ protected function parseImport(RouteCollection $collection, array $config, $path
         $subCollection->addRequirements($requirements);
         $subCollection->addOptions($options);
 
+        if (isset($config['name_prefix'])) {
+            $subCollection->addNamePrefix($config['name_prefix']);
+        }
+
         $collection->addCollection($subCollection);
     }
 

src/Symfony/Component/Routing/Loader/schema/routing/routing-1.0.xsd

@@ -50,6 +50,7 @@
     <xsd:attribute name="resource" type="xsd:string" use="required" />
     <xsd:attribute name="type" type="xsd:string" />
     <xsd:attribute name="prefix" type="xsd:string" />
+    <xsd:attribute name="name-prefix" type="xsd:string" />
     <xsd:attribute name="host" type="xsd:string" />
     <xsd:attribute name="schemes" type="xsd:string" />
     <xsd:attribute name="methods" type="xsd:string" />

src/Symfony/Component/Routing/RouteCollection.php

@@ -153,6 +153,20 @@ public function addPrefix($prefix, array $defaults = array(), array $requirement
         }
     }
 
+    /**
+     * Adds a prefix to the name of all the routes within in the collection.
+     */
+    public function addNamePrefix(string $prefix)
+    {
+        $prefixedRoutes = array();
+
+        foreach ($this->routes as $name => $route) {
+            $prefixedRoutes[$prefix.$name] = $route;
+        }
+
+        $this->routes = $prefixedRoutes;
+    }
+
     /**
      * Sets the host pattern on all routes.
      *

src/Symfony/Component/Routing/Tests/Fixtures/import_with_name_prefix/routing.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<routes xmlns="http://symfony.com/schema/routing"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="http://symfony.com/schema/routing
+        http://symfony.com/schema/routing/routing-1.0.xsd">
+
+    <import resource="../controller/routing.xml" />
+    <import resource="../controller/routing.xml" prefix="/api" name-prefix="api_" />
+
+</routes>

src/Symfony/Component/Routing/Tests/Fixtures/import_with_name_prefix/routing.yml

@@ -0,0 +1,7 @@
+app:
+    resource: ../controller/routing.yml
+
+api:
+    resource: ../controller/routing.yml
+    name_prefix: api_
+    prefix: /api

src/Symfony/Component/Routing/Tests/Fixtures/nonvalidkeys.yml

@@ -1,3 +1,3 @@
 someroute:
   resource: path/to/some.yml
-  name_prefix: test_
+  not_valid_key: test_

src/Symfony/Component/Routing/Tests/Loader/XmlFileLoaderTest.php

@@ -361,4 +361,15 @@ public function testImportWithOverriddenController()
         $loader = new XmlFileLoader(new FileLocator(array(__DIR__.'/../Fixtures/controller')));
         $loader->load('import_override_defaults.xml');
     }
+
+    public function testImportRouteWithNamePrefix()
+    {
+        $loader = new XmlFileLoader(new FileLocator(array(__DIR__.'/../Fixtures/import_with_name_prefix')));
+        $routeCollection = $loader->load('routing.xml');
+
+        $this->assertNotNull($routeCollection->get('app_blog'));
+        $this->assertEquals('/blog', $routeCollection->get('app_blog')->getPath());
+        $this->assertNotNull($routeCollection->get('api_app_blog'));
+        $this->assertEquals('/api/blog', $routeCollection->get('api_app_blog')->getPath());
+    }
 }

src/Symfony/Component/Routing/Tests/Loader/YamlFileLoaderTest.php

@@ -182,4 +182,15 @@ public function testImportWithOverriddenController()
         $loader = new YamlFileLoader(new FileLocator(array(__DIR__.'/../Fixtures/controller')));
         $loader->load('import_override_defaults.yml');
     }
+
+    public function testImportRouteWithNamePrefix()
+    {
+        $loader = new YamlFileLoader(new FileLocator(array(__DIR__.'/../Fixtures/import_with_name_prefix')));
+        $routeCollection = $loader->load('routing.yml');
+
+        $this->assertNotNull($routeCollection->get('app_blog'));
+        $this->assertEquals('/blog', $routeCollection->get('app_blog')->getPath());
+        $this->assertNotNull($routeCollection->get('api_app_blog'));
+        $this->assertEquals('/api/blog', $routeCollection->get('api_app_blog')->getPath());
+    }
 }