symfony · fabpot · Dec 6, 2012 · Nov 26, 2012 · Nov 26, 2012 · Nov 27, 2012
diff --git a/UPGRADE-2.2.md b/UPGRADE-2.2.md
@@ -36,6 +36,42 @@
 
   * The PasswordType is now not trimmed by default.
 
+### Routing
+
+ * RouteCollection does not behave like a tree structure anymore but as a flat
+   array of Routes. So when using PHP to build the RouteCollection, you must
+   make sure to add routes to the sub-collection before adding it to the parent
+   collection (this is not relevant when using YAML or XML for Route definitions).
+
+   Before:
+
+   ```
+   $rootCollection = new RouteCollection();
+   $subCollection = new RouteCollection();
+   $rootCollection->addCollection($subCollection);
+   $subCollection->add('foo', new Route('/foo'));
+   ```
+
+   After:
+
+   ```
+   $rootCollection = new RouteCollection();
+   $subCollection = new RouteCollection();
+   $subCollection->add('foo', new Route('/foo'));
+   $rootCollection->addCollection($subCollection);
+   ```
+
+   Also one must call `addCollection` from the bottom to the top hierarchy.
+   So the correct sequence is the following (and not the reverse):
+
+   ```
+   $childCollection->->addCollection($grandchildCollection);
+   $rootCollection->addCollection($childCollection);
+   ```
+
+ * The methods `RouteCollection::getParent()` and `RouteCollection::getRoot()`
+   have been deprecated and will be removed in Symfony 2.3.
+
 ### Validator
 
  * Interfaces were created for created for the classes `ConstraintViolation`,

diff --git a/src/Symfony/Bundle/FrameworkBundle/Routing/Router.php b/src/Symfony/Bundle/FrameworkBundle/Routing/Router.php
@@ -84,19 +84,15 @@ public function warmUp($cacheDir)
     private function resolveParameters(RouteCollection $collection)
     {
         foreach ($collection as $route) {
-            if ($route instanceof RouteCollection) {
-                $this->resolveParameters($route);
-            } else {
-                foreach ($route->getDefaults() as $name => $value) {
-                    $route->setDefault($name, $this->resolve($value));
-                }
-
-                foreach ($route->getRequirements() as $name => $value) {
-                     $route->setRequirement($name, $this->resolve($value));
-                }
-
-                $route->setPattern($this->resolve($route->getPattern()));
+            foreach ($route->getDefaults() as $name => $value) {
+                $route->setDefault($name, $this->resolve($value));
             }
+
+            foreach ($route->getRequirements() as $name => $value) {
+                 $route->setRequirement($name, $this->resolve($value));
+            }
+
+            $route->setPattern($this->resolve($route->getPattern()));
         }
     }
 

diff --git a/src/Symfony/Component/Routing/CHANGELOG.md b/src/Symfony/Component/Routing/CHANGELOG.md
@@ -4,6 +4,39 @@ CHANGELOG
 2.2.0
 -----
 
+ * [BC BREAK] RouteCollection does not behave like a tree structure anymore but as
+   a flat array of Routes. So when using PHP to build the RouteCollection, you must
+   make sure to add routes to the sub-collection before adding it to the parent
+   collection (this is not relevant when using YAML or XML for Route definitions).
+
+   Before:
+
+   ```
+   $rootCollection = new RouteCollection();
+   $subCollection = new RouteCollection();
+   $rootCollection->addCollection($subCollection);
+   $subCollection->add('foo', new Route('/foo'));
+   ```
+
+   After:
+
+   ```
+   $rootCollection = new RouteCollection();
+   $subCollection = new RouteCollection();
+   $subCollection->add('foo', new Route('/foo'));
+   $rootCollection->addCollection($subCollection);
+   ```
+
+   Also one must call `addCollection` from the bottom to the top hierarchy.
+   So the correct sequence is the following (and not the reverse):
+
+   ```
+   $childCollection->->addCollection($grandchildCollection);
+   $rootCollection->addCollection($childCollection);
+   ```
+
+ * The methods `RouteCollection::getParent()` and `RouteCollection::getRoot()`
+   have been deprecated and will be removed in Symfony 2.3.
  * added support for the method default argument values when defining a @Route
  * Adjacent placeholders without separator work now, e.g. `/{x}{y}{z}.{_format}`.
  * Characters that function as separator between placeholders are now whitelisted

diff --git a/src/Symfony/Component/Routing/Matcher/Dumper/PhpMatcherDumper.php b/src/Symfony/Component/Routing/Matcher/Dumper/PhpMatcherDumper.php
@@ -111,7 +111,6 @@ private function compileRoutes(RouteCollection $routes, $supportsRedirections)
     {
         $fetchedHostname = false;
 
-        $routes = $this->flattenRouteCollection($routes);
         $groups = $this->groupRoutesByHostnameRegex($routes);
         $code = '';
 
@@ -321,31 +320,6 @@ private function compileRoute(Route $route, $name, $supportsRedirections, $paren
         return $code;
     }
 
-    /**
-     * Flattens a tree of routes to a single collection.
-     *
-     * @param RouteCollection       $routes Collection of routes
-     * @param DumperCollection|null $to     A DumperCollection to add routes to
-     *
-     * @return DumperCollection
-     */
-    private function flattenRouteCollection(RouteCollection $routes, DumperCollection $to = null)
-    {
-        if (null === $to) {
-            $to = new DumperCollection();
-        }
-
-        foreach ($routes as $name => $route) {
-            if ($route instanceof RouteCollection) {
-                $this->flattenRouteCollection($route, $to);
-            } else {
-                $to->add(new DumperRoute($name, $route));
-            }
-        }
-
-        return $to;
-    }
-
     /**
      * Groups consecutive routes having the same hostname regex.
      *
@@ -355,22 +329,22 @@ private function flattenRouteCollection(RouteCollection $routes, DumperCollectio
      *
      * @return DumperCollection A collection with routes grouped by hostname regex in sub-collections
      */
-    private function groupRoutesByHostnameRegex(DumperCollection $routes)
+    private function groupRoutesByHostnameRegex(RouteCollection $routes)
     {
         $groups = new DumperCollection();
 
         $currentGroup = new DumperCollection();
         $currentGroup->setAttribute('hostname_regex', null);
         $groups->add($currentGroup);
 
-        foreach ($routes as $route) {
-            $hostnameRegex = $route->getRoute()->compile()->getHostnameRegex();
+        foreach ($routes as $name => $route) {
+            $hostnameRegex = $route->compile()->getHostnameRegex();
             if ($currentGroup->getAttribute('hostname_regex') !== $hostnameRegex) {
                 $currentGroup = new DumperCollection();
                 $currentGroup->setAttribute('hostname_regex', $hostnameRegex);
                 $groups->add($currentGroup);
             }
-            $currentGroup->add($route);
+            $currentGroup->add(new DumperRoute($name, $route));
         }
 
         return $groups;

diff --git a/src/Symfony/Component/Routing/Matcher/TraceableUrlMatcher.php b/src/Symfony/Component/Routing/Matcher/TraceableUrlMatcher.php
@@ -44,14 +44,6 @@ public function getTraces($pathinfo)
     protected function matchCollection($pathinfo, RouteCollection $routes)
     {
         foreach ($routes as $name => $route) {
-            if ($route instanceof RouteCollection) {
-                if (!$ret = $this->matchCollection($pathinfo, $route)) {
-                    continue;
-                }
-
-                return true;
-            }
-
             $compiledRoute = $route->compile();
 
             if (!preg_match($compiledRoute->getRegex(), $pathinfo, $matches)) {

diff --git a/src/Symfony/Component/Routing/Matcher/UrlMatcher.php b/src/Symfony/Component/Routing/Matcher/UrlMatcher.php
@@ -105,18 +105,6 @@ public function match($pathinfo)
     protected function matchCollection($pathinfo, RouteCollection $routes)
     {
         foreach ($routes as $name => $route) {
-            if ($route instanceof RouteCollection) {
-                if (false === strpos($route->getPrefix(), '{') && $route->getPrefix() !== substr($pathinfo, 0, strlen($route->getPrefix()))) {
-                    continue;
-                }
-
-                if (!$ret = $this->matchCollection($pathinfo, $route)) {
-                    continue;
-                }
-
-                return $ret;
-            }
-
             $compiledRoute = $route->compile();
 
             // check the static prefix of the URL first. Only use the more expensive preg_match when it matches