Upgrade framework

vendor/symfony/routing/RouteCollection.php

@@ -12,6 +12,8 @@
 namespace Symfony\Component\Routing;
 
 use Symfony\Component\Config\Resource\ResourceInterface;
+use Symfony\Component\Routing\Exception\InvalidArgumentException;
+use Symfony\Component\Routing\Exception\RouteCircularReferenceException;
 
 /**
  * A RouteCollection represents a set of Route instances.
@@ -22,24 +24,40 @@ use Symfony\Component\Config\Resource\ResourceInterface;
  *
  * @author Fabien Potencier <fabien@symfony.com>
  * @author Tobias Schultze <http://tobion.de>
+ *
+ * @implements \IteratorAggregate<string, Route>
  */
 class RouteCollection implements \IteratorAggregate, \Countable
 {
     /**
-     * @var Route[]
+     * @var array<string, Route>
      */
-    private $routes = array();
+    private array $routes = [];
 
     /**
-     * @var array
+     * @var array<string, Alias>
      */
-    private $resources = array();
+    private $aliases = [];
+
+    /**
+     * @var array<string, ResourceInterface>
+     */
+    private array $resources = [];
+
+    /**
+     * @var array<string, int>
+     */
+    private array $priorities = [];
 
     public function __clone()
     {
         foreach ($this->routes as $name => $route) {
             $this->routes[$name] = clone $route;
         }
+
+        foreach ($this->aliases as $name => $alias) {
+            $this->aliases[$name] = clone $alias;
+        }
     }
 
     /**
@@ -49,96 +67,120 @@ class RouteCollection implements \IteratorAggregate, \Countable
      *
      * @see all()
      *
-     * @return \ArrayIterator|Route[] An \ArrayIterator object for iterating over routes
+     * @return \ArrayIterator<string, Route>
      */
-    public function getIterator()
+    public function getIterator(): \ArrayIterator
     {
-        return new \ArrayIterator($this->routes);
+        return new \ArrayIterator($this->all());
     }
 
     /**
      * Gets the number of Routes in this collection.
-     *
-     * @return int The number of routes
      */
-    public function count()
+    public function count(): int
     {
-        return count($this->routes);
+        return \count($this->routes);
     }
 
-    /**
-     * Adds a route.
-     *
-     * @param string $name  The route name
-     * @param Route  $route A Route instance
-     */
-    public function add($name, Route $route)
+    public function add(string $name, Route $route, int $priority = 0)
     {
-        unset($this->routes[$name]);
+        unset($this->routes[$name], $this->priorities[$name], $this->aliases[$name]);
 
         $this->routes[$name] = $route;
+
+        if ($priority) {
+            $this->priorities[$name] = $priority;
+        }
     }
 
     /**
      * Returns all routes in this collection.
      *
-     * @return Route[] An array of routes
+     * @return array<string, Route>
      */
-    public function all()
+    public function all(): array
     {
+        if ($this->priorities) {
+            $priorities = $this->priorities;
+            $keysOrder = array_flip(array_keys($this->routes));
+            uksort($this->routes, static function ($n1, $n2) use ($priorities, $keysOrder) {
+                return (($priorities[$n2] ?? 0) <=> ($priorities[$n1] ?? 0)) ?: ($keysOrder[$n1] <=> $keysOrder[$n2]);
+            });
+        }
+
         return $this->routes;
     }
 
     /**
      * Gets a route by name.
-     *
-     * @param string $name The route name
-     *
-     * @return Route|null A Route instance or null when not found
      */
-    public function get($name)
+    public function get(string $name): ?Route
     {
-        return isset($this->routes[$name]) ? $this->routes[$name] : null;
+        $visited = [];
+        while (null !== $alias = $this->aliases[$name] ?? null) {
+            if (false !== $searchKey = array_search($name, $visited)) {
+                $visited[] = $name;
+
+                throw new RouteCircularReferenceException($name, \array_slice($visited, $searchKey));
+            }
+
+            if ($alias->isDeprecated()) {
+                $deprecation = $alias->getDeprecation($name);
+
+                trigger_deprecation($deprecation['package'], $deprecation['version'], $deprecation['message']);
+            }
+
+            $visited[] = $name;
+            $name = $alias->getId();
+        }
+
+        return $this->routes[$name] ?? null;
     }
 
     /**
      * Removes a route or an array of routes by name from the collection.
      *
-     * @param string|array $name The route name or an array of route names
+     * @param string|string[] $name The route name or an array of route names
      */
-    public function remove($name)
+    public function remove(string|array $name)
     {
         foreach ((array) $name as $n) {
-            unset($this->routes[$n]);
+            unset($this->routes[$n], $this->priorities[$n], $this->aliases[$n]);
         }
     }
 
     /**
      * Adds a route collection at the end of the current set by appending all
      * routes of the added collection.
-     *
-     * @param RouteCollection $collection A RouteCollection instance
      */
-    public function addCollection(RouteCollection $collection)
+    public function addCollection(self $collection)
     {
         // we need to remove all routes with the same names first because just replacing them
         // would not place the new route at the end of the merged array
         foreach ($collection->all() as $name => $route) {
-            unset($this->routes[$name]);
+            unset($this->routes[$name], $this->priorities[$name], $this->aliases[$name]);
             $this->routes[$name] = $route;
+
+            if (isset($collection->priorities[$name])) {
+                $this->priorities[$name] = $collection->priorities[$name];
+            }
         }
 
-        $this->resources = array_merge($this->resources, $collection->getResources());
+        foreach ($collection->getAliases() as $name => $alias) {
+            unset($this->routes[$name], $this->priorities[$name], $this->aliases[$name]);
+
+            $this->aliases[$name] = $alias;
+        }
+
+        foreach ($collection->getResources() as $resource) {
+            $this->addResource($resource);
+        }
     }
 
     /**
      * Adds a prefix to the path of all child routes.
-     *
-     * @param string $prefix       An optional prefix to add before each pattern of the route collection
-     * @param array  $defaults     An array of default values
-     * @param array  $requirements An array of requirements
      */
-    public function addPrefix($prefix, array $defaults = array(), array $requirements = array())
+    public function addPrefix(string $prefix, array $defaults = [], array $requirements = [])
     {
         $prefix = trim(trim($prefix), '/');
 
@@ -154,13 +196,37 @@ class RouteCollection implements \IteratorAggregate, \Countable
     }
 
     /**
-     * Sets the host pattern on all routes.
-     *
-     * @param string $pattern      The pattern
-     * @param array  $defaults     An array of default values
-     * @param array  $requirements An array of requirements
+     * Adds a prefix to the name of all the routes within in the collection.
      */
-    public function setHost($pattern, array $defaults = array(), array $requirements = array())
+    public function addNamePrefix(string $prefix)
+    {
+        $prefixedRoutes = [];
+        $prefixedPriorities = [];
+        $prefixedAliases = [];
+
+        foreach ($this->routes as $name => $route) {
+            $prefixedRoutes[$prefix.$name] = $route;
+            if (null !== $canonicalName = $route->getDefault('_canonical_route')) {
+                $route->setDefault('_canonical_route', $prefix.$canonicalName);
+            }
+            if (isset($this->priorities[$name])) {
+                $prefixedPriorities[$prefix.$name] = $this->priorities[$name];
+            }
+        }
+
+        foreach ($this->aliases as $name => $alias) {
+            $prefixedAliases[$prefix.$name] = $alias->withId($prefix.$alias->getId());
+        }
+
+        $this->routes = $prefixedRoutes;
+        $this->priorities = $prefixedPriorities;
+        $this->aliases = $prefixedAliases;
+    }
+
+    /**
+     * Sets the host pattern on all routes.
+     */
+    public function setHost(?string $pattern, array $defaults = [], array $requirements = [])
     {
         foreach ($this->routes as $route) {
             $route->setHost($pattern);
@@ -173,10 +239,8 @@ class RouteCollection implements \IteratorAggregate, \Countable
      * Sets a condition on all routes.
      *
      * Existing conditions will be overridden.
-     *
-     * @param string $condition The condition
      */
-    public function setCondition($condition)
+    public function setCondition(?string $condition)
     {
         foreach ($this->routes as $route) {
             $route->setCondition($condition);
@@ -187,8 +251,6 @@ class RouteCollection implements \IteratorAggregate, \Countable
      * Adds defaults to all routes.
      *
      * An existing default value under the same name in a route will be overridden.
-     *
-     * @param array $defaults An array of default values
      */
     public function addDefaults(array $defaults)
     {
@@ -203,8 +265,6 @@ class RouteCollection implements \IteratorAggregate, \Countable
      * Adds requirements to all routes.
      *
      * An existing requirement under the same name in a route will be overridden.
-     *
-     * @param array $requirements An array of requirements
      */
     public function addRequirements(array $requirements)
     {
@@ -219,8 +279,6 @@ class RouteCollection implements \IteratorAggregate, \Countable
      * Adds options to all routes.
      *
      * An existing option value under the same name in a route will be overridden.
-     *
-     * @param array $options An array of options
      */
     public function addOptions(array $options)
     {
@@ -234,9 +292,9 @@ class RouteCollection implements \IteratorAggregate, \Countable
     /**
      * Sets the schemes (e.g. 'https') all child routes are restricted to.
      *
-     * @param string|array $schemes The scheme or an array of schemes
+     * @param string|string[] $schemes The scheme or an array of schemes
      */
-    public function setSchemes($schemes)
+    public function setSchemes(string|array $schemes)
     {
         foreach ($this->routes as $route) {
             $route->setSchemes($schemes);
@@ -246,9 +304,9 @@ class RouteCollection implements \IteratorAggregate, \Countable
     /**
      * Sets the HTTP methods (e.g. 'POST') all child routes are restricted to.
      *
-     * @param string|array $methods The method or an array of methods
+     * @param string|string[] $methods The method or an array of methods
      */
-    public function setMethods($methods)
+    public function setMethods(string|array $methods)
     {
         foreach ($this->routes as $route) {
             $route->setMethods($methods);
@@ -258,20 +316,55 @@ class RouteCollection implements \IteratorAggregate, \Countable
     /**
      * Returns an array of resources loaded to build this collection.
      *
-     * @return ResourceInterface[] An array of resources
+     * @return ResourceInterface[]
      */
-    public function getResources()
+    public function getResources(): array
     {
-        return array_unique($this->resources);
+        return array_values($this->resources);
     }
 
     /**
-     * Adds a resource for this collection.
-     *
-     * @param ResourceInterface $resource A resource instance
+     * Adds a resource for this collection. If the resource already exists
+     * it is not added.
      */
     public function addResource(ResourceInterface $resource)
     {
-        $this->resources[] = $resource;
+        $key = (string) $resource;
+
+        if (!isset($this->resources[$key])) {
+            $this->resources[$key] = $resource;
+        }
+    }
+
+    /**
+     * Sets an alias for an existing route.
+     *
+     * @param string $name  The alias to create
+     * @param string $alias The route to alias
+     *
+     * @throws InvalidArgumentException if the alias is for itself
+     */
+    public function addAlias(string $name, string $alias): Alias
+    {
+        if ($name === $alias) {
+            throw new InvalidArgumentException(sprintf('Route alias "%s" can not reference itself.', $name));
+        }
+
+        unset($this->routes[$name], $this->priorities[$name]);
+
+        return $this->aliases[$name] = new Alias($alias);
+    }
+
+    /**
+     * @return array<string, Alias>
+     */
+    public function getAliases(): array
+    {
+        return $this->aliases;
+    }
+
+    public function getAlias(string $name): ?Alias
+    {
+        return $this->aliases[$name] ?? null;
     }
 }