migration symfony 5 4 (#300)

* symfony 5.4 (diff dev) * symfony 5.4 (working) * symfony 5.4 (update autoload) * symfony 5.4 (remove swiftmailer mailer implementation) * symfony 5.4 (php doc and split Global accessor class) ### Impacted packages: composer require php:">=7.2.5 <8.0.0" symfony/console:5.4.* symfony/dotenv:5.4.* symfony/framework-bundle:5.4.* symfony/twig-bundle:5.4.* symfony/yaml:5.4.* --update-with-dependencies composer require symfony/stopwatch:5.4.* symfony/web-profiler-bundle:5.4.* --dev --update-with-dependencies
2026-04-24 11:08:45 +02:00 · 2022-06-16 09:13:24 +02:00
parent abb13b70b9
commit 79da71ecf8
2178 changed files with 87439 additions and 59451 deletions
--- a/lib/symfony/routing/Loader/Configurator/AliasConfigurator.php
+++ b/lib/symfony/routing/Loader/Configurator/AliasConfigurator.php
@@ -0,0 +1,43 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Routing\Loader\Configurator;
+
+use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
+use Symfony\Component\Routing\Alias;
+
+class AliasConfigurator
+{
+    private $alias;
+
+    public function __construct(Alias $alias)
+    {
+        $this->alias = $alias;
+    }
+
+    /**
+     * Whether this alias is deprecated, that means it should not be called anymore.
+     *
+     * @param string $package The name of the composer package that is triggering the deprecation
+     * @param string $version The version of the package that introduced the deprecation
+     * @param string $message The deprecation message to use
+     *
+     * @return $this
+     *
+     * @throws InvalidArgumentException when the message template is invalid
+     */
+    public function deprecate(string $package, string $version, string $message): self
+    {
+        $this->alias->setDeprecated($package, $version, $message);
+
+        return $this;
+    }
+}
--- a/lib/symfony/routing/Loader/Configurator/CollectionConfigurator.php
+++ b/lib/symfony/routing/Loader/Configurator/CollectionConfigurator.php
@@ -20,62 +20,106 @@ use Symfony\Component\Routing\RouteCollection;
 class CollectionConfigurator
 {
    use Traits\AddTrait;
+    use Traits\HostTrait;
    use Traits\RouteTrait;

    private $parent;
    private $parentConfigurator;
+    private $parentPrefixes;
+    private $host;

-    public function __construct(RouteCollection $parent, $name, self $parentConfigurator = null)
+    public function __construct(RouteCollection $parent, string $name, self $parentConfigurator = null, array $parentPrefixes = null)
    {
        $this->parent = $parent;
        $this->name = $name;
        $this->collection = new RouteCollection();
        $this->route = new Route('');
        $this->parentConfigurator = $parentConfigurator; // for GC control
+        $this->parentPrefixes = $parentPrefixes;
+    }
+
+    /**
+     * @return array
+     */
+    public function __sleep()
+    {
+        throw new \BadMethodCallException('Cannot serialize '.__CLASS__);
+    }
+
+    public function __wakeup()
+    {
+        throw new \BadMethodCallException('Cannot unserialize '.__CLASS__);
    }

    public function __destruct()
    {
-        $this->collection->addPrefix(rtrim($this->route->getPath(), '/'));
+        if (null === $this->prefixes) {
+            $this->collection->addPrefix($this->route->getPath());
+        }
+        if (null !== $this->host) {
+            $this->addHost($this->collection, $this->host);
+        }
+
        $this->parent->addCollection($this->collection);
    }

-    /**
-     * Adds a route.
-     *
-     * @param string $name
-     * @param string $path
-     *
-     * @return RouteConfigurator
-     */
-    final public function add($name, $path)
-    {
-        $this->collection->add($this->name.$name, $route = clone $this->route);
-
-        return new RouteConfigurator($this->collection, $route->setPath($path), $this->name, $this);
-    }
-
    /**
     * Creates a sub-collection.
-     *
-     * @return self
     */
-    final public function collection($name = '')
+    final public function collection(string $name = ''): self
    {
-        return new self($this->collection, $this->name.$name, $this);
+        return new self($this->collection, $this->name.$name, $this, $this->prefixes);
    }

    /**
     * Sets the prefix to add to the path of all child routes.
     *
-     * @param string $prefix
+     * @param string|array $prefix the prefix, or the localized prefixes
     *
     * @return $this
     */
-    final public function prefix($prefix)
+    final public function prefix($prefix): self
    {
-        $this->route->setPath($prefix);
+        if (\is_array($prefix)) {
+            if (null === $this->parentPrefixes) {
+                // no-op
+            } elseif ($missing = array_diff_key($this->parentPrefixes, $prefix)) {
+                throw new \LogicException(sprintf('Collection "%s" is missing prefixes for locale(s) "%s".', $this->name, implode('", "', array_keys($missing))));
+            } else {
+                foreach ($prefix as $locale => $localePrefix) {
+                    if (!isset($this->parentPrefixes[$locale])) {
+                        throw new \LogicException(sprintf('Collection "%s" with locale "%s" is missing a corresponding prefix in its parent collection.', $this->name, $locale));
+                    }
+
+                    $prefix[$locale] = $this->parentPrefixes[$locale].$localePrefix;
+                }
+            }
+            $this->prefixes = $prefix;
+            $this->route->setPath('/');
+        } else {
+            $this->prefixes = null;
+            $this->route->setPath($prefix);
+        }

        return $this;
    }
+
+    /**
+     * Sets the host to use for all child routes.
+     *
+     * @param string|array $host the host, or the localized hosts
+     *
+     * @return $this
+     */
+    final public function host($host): self
+    {
+        $this->host = $host;
+
+        return $this;
+    }
+
+    private function createRoute(string $path): Route
+    {
+        return (clone $this->route)->setPath($path);
+    }
 }
--- a/lib/symfony/routing/Loader/Configurator/ImportConfigurator.php
+++ b/lib/symfony/routing/Loader/Configurator/ImportConfigurator.php
@@ -18,6 +18,8 @@ use Symfony\Component\Routing\RouteCollection;
 */
 class ImportConfigurator
 {
+    use Traits\HostTrait;
+    use Traits\PrefixTrait;
    use Traits\RouteTrait;

    private $parent;
@@ -28,6 +30,19 @@ class ImportConfigurator
        $this->route = $route;
    }

+    /**
+     * @return array
+     */
+    public function __sleep()
+    {
+        throw new \BadMethodCallException('Cannot serialize '.__CLASS__);
+    }
+
+    public function __wakeup()
+    {
+        throw new \BadMethodCallException('Cannot unserialize '.__CLASS__);
+    }
+
    public function __destruct()
    {
        $this->parent->addCollection($this->route);
@@ -36,13 +51,39 @@ class ImportConfigurator
    /**
     * Sets the prefix to add to the path of all child routes.
     *
-     * @param string $prefix
+     * @param string|array $prefix the prefix, or the localized prefixes
     *
     * @return $this
     */
-    final public function prefix($prefix)
+    final public function prefix($prefix, bool $trailingSlashOnRoot = true): self
    {
-        $this->route->addPrefix($prefix);
+        $this->addPrefix($this->route, $prefix, $trailingSlashOnRoot);
+
+        return $this;
+    }
+
+    /**
+     * Sets the prefix to add to the name of all child routes.
+     *
+     * @return $this
+     */
+    final public function namePrefix(string $namePrefix): self
+    {
+        $this->route->addNamePrefix($namePrefix);
+
+        return $this;
+    }
+
+    /**
+     * Sets the host to use for all child routes.
+     *
+     * @param string|array $host the host, or the localized hosts
+     *
+     * @return $this
+     */
+    final public function host($host): self
+    {
+        $this->addHost($this->route, $host);

        return $this;
    }
--- a/lib/symfony/routing/Loader/Configurator/RouteConfigurator.php
+++ b/lib/symfony/routing/Loader/Configurator/RouteConfigurator.php
@@ -11,7 +11,6 @@

 namespace Symfony\Component\Routing\Loader\Configurator;

-use Symfony\Component\Routing\Route;
 use Symfony\Component\Routing\RouteCollection;

 /**
@@ -20,15 +19,31 @@ use Symfony\Component\Routing\RouteCollection;
 class RouteConfigurator
 {
    use Traits\AddTrait;
+    use Traits\HostTrait;
    use Traits\RouteTrait;

-    private $parentConfigurator;
+    protected $parentConfigurator;

-    public function __construct(RouteCollection $collection, Route $route, $name = '', CollectionConfigurator $parentConfigurator = null)
+    public function __construct(RouteCollection $collection, RouteCollection $route, string $name = '', CollectionConfigurator $parentConfigurator = null, array $prefixes = null)
    {
        $this->collection = $collection;
        $this->route = $route;
        $this->name = $name;
        $this->parentConfigurator = $parentConfigurator; // for GC control
+        $this->prefixes = $prefixes;
+    }
+
+    /**
+     * Sets the host to use for all child routes.
+     *
+     * @param string|array $host the host, or the localized hosts
+     *
+     * @return $this
+     */
+    final public function host($host): self
+    {
+        $this->addHost($this->route, $host);
+
+        return $this;
    }
 }
--- a/lib/symfony/routing/Loader/Configurator/RoutingConfigurator.php
+++ b/lib/symfony/routing/Loader/Configurator/RoutingConfigurator.php
@@ -24,23 +24,25 @@ class RoutingConfigurator
    private $loader;
    private $path;
    private $file;
+    private $env;

-    public function __construct(RouteCollection $collection, PhpFileLoader $loader, $path, $file)
+    public function __construct(RouteCollection $collection, PhpFileLoader $loader, string $path, string $file, string $env = null)
    {
        $this->collection = $collection;
        $this->loader = $loader;
        $this->path = $path;
        $this->file = $file;
+        $this->env = $env;
    }

    /**
-     * @return ImportConfigurator
+     * @param string|string[]|null $exclude Glob patterns to exclude from the import
     */
-    final public function import($resource, $type = null, $ignoreErrors = false)
+    final public function import($resource, string $type = null, bool $ignoreErrors = false, $exclude = null): ImportConfigurator
    {
        $this->loader->setCurrentDir(\dirname($this->path));
-        $imported = $this->loader->import($resource, $type, $ignoreErrors, $this->file) ?: [];

+        $imported = $this->loader->import($resource, $type, $ignoreErrors, $this->file, $exclude) ?: [];
        if (!\is_array($imported)) {
            return new ImportConfigurator($this->collection, $imported);
        }
@@ -53,11 +55,27 @@ class RoutingConfigurator
        return new ImportConfigurator($this->collection, $mergedCollection);
    }

-    /**
-     * @return CollectionConfigurator
-     */
-    final public function collection($name = '')
+    final public function collection(string $name = ''): CollectionConfigurator
    {
        return new CollectionConfigurator($this->collection, $name);
    }
+
+    /**
+     * Get the current environment to be able to write conditional configuration.
+     */
+    final public function env(): ?string
+    {
+        return $this->env;
+    }
+
+    /**
+     * @return static
+     */
+    final public function withPath(string $path): self
+    {
+        $clone = clone $this;
+        $clone->path = $clone->file = $path;
+
+        return $clone;
+    }
 }
--- a/lib/symfony/routing/Loader/Configurator/Traits/AddTrait.php
+++ b/lib/symfony/routing/Loader/Configurator/Traits/AddTrait.php
@@ -11,44 +11,49 @@

 namespace Symfony\Component\Routing\Loader\Configurator\Traits;

+use Symfony\Component\Routing\Loader\Configurator\AliasConfigurator;
+use Symfony\Component\Routing\Loader\Configurator\CollectionConfigurator;
 use Symfony\Component\Routing\Loader\Configurator\RouteConfigurator;
-use Symfony\Component\Routing\Route;
 use Symfony\Component\Routing\RouteCollection;

+/**
+ * @author Nicolas Grekas <p@tchwork.com>
+ */
 trait AddTrait
 {
+    use LocalizedRouteTrait;
+
    /**
     * @var RouteCollection
     */
-    private $collection;
-
-    private $name = '';
+    protected $collection;
+    protected $name = '';
+    protected $prefixes;

    /**
     * Adds a route.
     *
-     * @param string $name
-     * @param string $path
-     *
-     * @return RouteConfigurator
+     * @param string|array $path the path, or the localized paths of the route
     */
-    final public function add($name, $path)
+    public function add(string $name, $path): RouteConfigurator
    {
-        $parentConfigurator = $this instanceof RouteConfigurator ? $this->parentConfigurator : null;
-        $this->collection->add($this->name.$name, $route = new Route($path));
+        $parentConfigurator = $this instanceof CollectionConfigurator ? $this : ($this instanceof RouteConfigurator ? $this->parentConfigurator : null);
+        $route = $this->createLocalizedRoute($this->collection, $name, $path, $this->name, $this->prefixes);

-        return new RouteConfigurator($this->collection, $route, '', $parentConfigurator);
+        return new RouteConfigurator($this->collection, $route, $this->name, $parentConfigurator, $this->prefixes);
+    }
+
+    public function alias(string $name, string $alias): AliasConfigurator
+    {
+        return new AliasConfigurator($this->collection->addAlias($name, $alias));
    }

    /**
     * Adds a route.
     *
-     * @param string $name
-     * @param string $path
-     *
-     * @return RouteConfigurator
+     * @param string|array $path the path, or the localized paths of the route
     */
-    final public function __invoke($name, $path)
+    public function __invoke(string $name, $path): RouteConfigurator
    {
        return $this->add($name, $path);
    }
--- a/lib/symfony/routing/Loader/Configurator/Traits/HostTrait.php
+++ b/lib/symfony/routing/Loader/Configurator/Traits/HostTrait.php
@@ -0,0 +1,49 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Routing\Loader\Configurator\Traits;
+
+use Symfony\Component\Routing\RouteCollection;
+
+/**
+ * @internal
+ */
+trait HostTrait
+{
+    final protected function addHost(RouteCollection $routes, $hosts)
+    {
+        if (!$hosts || !\is_array($hosts)) {
+            $routes->setHost($hosts ?: '');
+
+            return;
+        }
+
+        foreach ($routes->all() as $name => $route) {
+            if (null === $locale = $route->getDefault('_locale')) {
+                $routes->remove($name);
+                foreach ($hosts as $locale => $host) {
+                    $localizedRoute = clone $route;
+                    $localizedRoute->setDefault('_locale', $locale);
+                    $localizedRoute->setRequirement('_locale', preg_quote($locale));
+                    $localizedRoute->setDefault('_canonical_route', $name);
+                    $localizedRoute->setHost($host);
+                    $routes->add($name.'.'.$locale, $localizedRoute);
+                }
+            } elseif (!isset($hosts[$locale])) {
+                throw new \InvalidArgumentException(sprintf('Route "%s" with locale "%s" is missing a corresponding host in its parent collection.', $name, $locale));
+            } else {
+                $route->setHost($hosts[$locale]);
+                $route->setRequirement('_locale', preg_quote($locale));
+                $routes->add($name, $route);
+            }
+        }
+    }
+}
--- a/lib/symfony/routing/Loader/Configurator/Traits/LocalizedRouteTrait.php
+++ b/lib/symfony/routing/Loader/Configurator/Traits/LocalizedRouteTrait.php
@@ -0,0 +1,76 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Routing\Loader\Configurator\Traits;
+
+use Symfony\Component\Routing\Route;
+use Symfony\Component\Routing\RouteCollection;
+
+/**
+ * @internal
+ *
+ * @author Nicolas Grekas <p@tchwork.com>
+ * @author Jules Pietri <jules@heahprod.com>
+ */
+trait LocalizedRouteTrait
+{
+    /**
+     * Creates one or many routes.
+     *
+     * @param string|array $path the path, or the localized paths of the route
+     */
+    final protected function createLocalizedRoute(RouteCollection $collection, string $name, $path, string $namePrefix = '', array $prefixes = null): RouteCollection
+    {
+        $paths = [];
+
+        $routes = new RouteCollection();
+
+        if (\is_array($path)) {
+            if (null === $prefixes) {
+                $paths = $path;
+            } elseif ($missing = array_diff_key($prefixes, $path)) {
+                throw new \LogicException(sprintf('Route "%s" is missing routes for locale(s) "%s".', $name, implode('", "', array_keys($missing))));
+            } else {
+                foreach ($path as $locale => $localePath) {
+                    if (!isset($prefixes[$locale])) {
+                        throw new \LogicException(sprintf('Route "%s" with locale "%s" is missing a corresponding prefix in its parent collection.', $name, $locale));
+                    }
+
+                    $paths[$locale] = $prefixes[$locale].$localePath;
+                }
+            }
+        } elseif (null !== $prefixes) {
+            foreach ($prefixes as $locale => $prefix) {
+                $paths[$locale] = $prefix.$path;
+            }
+        } else {
+            $routes->add($namePrefix.$name, $route = $this->createRoute($path));
+            $collection->add($namePrefix.$name, $route);
+
+            return $routes;
+        }
+
+        foreach ($paths as $locale => $path) {
+            $routes->add($name.'.'.$locale, $route = $this->createRoute($path));
+            $collection->add($namePrefix.$name.'.'.$locale, $route);
+            $route->setDefault('_locale', $locale);
+            $route->setRequirement('_locale', preg_quote($locale));
+            $route->setDefault('_canonical_route', $namePrefix.$name);
+        }
+
+        return $routes;
+    }
+
+    private function createRoute(string $path): Route
+    {
+        return new Route($path);
+    }
+}
--- a/lib/symfony/routing/Loader/Configurator/Traits/PrefixTrait.php
+++ b/lib/symfony/routing/Loader/Configurator/Traits/PrefixTrait.php
@@ -0,0 +1,62 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Routing\Loader\Configurator\Traits;
+
+use Symfony\Component\Routing\Route;
+use Symfony\Component\Routing\RouteCollection;
+
+/**
+ * @internal
+ *
+ * @author Nicolas Grekas <p@tchwork.com>
+ */
+trait PrefixTrait
+{
+    final protected function addPrefix(RouteCollection $routes, $prefix, bool $trailingSlashOnRoot)
+    {
+        if (\is_array($prefix)) {
+            foreach ($prefix as $locale => $localePrefix) {
+                $prefix[$locale] = trim(trim($localePrefix), '/');
+            }
+            foreach ($routes->all() as $name => $route) {
+                if (null === $locale = $route->getDefault('_locale')) {
+                    $routes->remove($name);
+                    foreach ($prefix as $locale => $localePrefix) {
+                        $localizedRoute = clone $route;
+                        $localizedRoute->setDefault('_locale', $locale);
+                        $localizedRoute->setRequirement('_locale', preg_quote($locale));
+                        $localizedRoute->setDefault('_canonical_route', $name);
+                        $localizedRoute->setPath($localePrefix.(!$trailingSlashOnRoot && '/' === $route->getPath() ? '' : $route->getPath()));
+                        $routes->add($name.'.'.$locale, $localizedRoute);
+                    }
+                } elseif (!isset($prefix[$locale])) {
+                    throw new \InvalidArgumentException(sprintf('Route "%s" with locale "%s" is missing a corresponding prefix in its parent collection.', $name, $locale));
+                } else {
+                    $route->setPath($prefix[$locale].(!$trailingSlashOnRoot && '/' === $route->getPath() ? '' : $route->getPath()));
+                    $routes->add($name, $route);
+                }
+            }
+
+            return;
+        }
+
+        $routes->addPrefix($prefix);
+        if (!$trailingSlashOnRoot) {
+            $rootPath = (new Route(trim(trim($prefix), '/').'/'))->getPath();
+            foreach ($routes->all() as $route) {
+                if ($route->getPath() === $rootPath) {
+                    $route->setPath(rtrim($rootPath, '/'));
+                }
+            }
+        }
+    }
+}
--- a/lib/symfony/routing/Loader/Configurator/Traits/RouteTrait.php
+++ b/lib/symfony/routing/Loader/Configurator/Traits/RouteTrait.php
@@ -19,14 +19,14 @@ trait RouteTrait
    /**
     * @var RouteCollection|Route
     */
-    private $route;
+    protected $route;

    /**
     * Adds defaults.
     *
     * @return $this
     */
-    final public function defaults(array $defaults)
+    final public function defaults(array $defaults): self
    {
        $this->route->addDefaults($defaults);

@@ -38,7 +38,7 @@ trait RouteTrait
     *
     * @return $this
     */
-    final public function requirements(array $requirements)
+    final public function requirements(array $requirements): self
    {
        $this->route->addRequirements($requirements);

@@ -50,7 +50,7 @@ trait RouteTrait
     *
     * @return $this
     */
-    final public function options(array $options)
+    final public function options(array $options): self
    {
        $this->route->addOptions($options);

@@ -58,13 +58,23 @@ trait RouteTrait
    }

    /**
-     * Sets the condition.
-     *
-     * @param string $condition
+     * Whether paths should accept utf8 encoding.
     *
     * @return $this
     */
-    final public function condition($condition)
+    final public function utf8(bool $utf8 = true): self
+    {
+        $this->route->addOptions(['utf8' => $utf8]);
+
+        return $this;
+    }
+
+    /**
+     * Sets the condition.
+     *
+     * @return $this
+     */
+    final public function condition(string $condition): self
    {
        $this->route->setCondition($condition);

@@ -74,11 +84,9 @@ trait RouteTrait
    /**
     * Sets the pattern for the host.
     *
-     * @param string $pattern
-     *
     * @return $this
     */
-    final public function host($pattern)
+    final public function host(string $pattern): self
    {
        $this->route->setHost($pattern);

@@ -93,7 +101,7 @@ trait RouteTrait
     *
     * @return $this
     */
-    final public function schemes(array $schemes)
+    final public function schemes(array $schemes): self
    {
        $this->route->setSchemes($schemes);

@@ -108,7 +116,7 @@ trait RouteTrait
     *
     * @return $this
     */
-    final public function methods(array $methods)
+    final public function methods(array $methods): self
    {
        $this->route->setMethods($methods);

@@ -118,14 +126,50 @@ trait RouteTrait
    /**
     * Adds the "_controller" entry to defaults.
     *
-     * @param callable|string $controller a callable or parseable pseudo-callable
+     * @param callable|string|array $controller a callable or parseable pseudo-callable
     *
     * @return $this
     */
-    final public function controller($controller)
+    final public function controller($controller): self
    {
        $this->route->addDefaults(['_controller' => $controller]);

        return $this;
    }
+
+    /**
+     * Adds the "_locale" entry to defaults.
+     *
+     * @return $this
+     */
+    final public function locale(string $locale): self
+    {
+        $this->route->addDefaults(['_locale' => $locale]);
+
+        return $this;
+    }
+
+    /**
+     * Adds the "_format" entry to defaults.
+     *
+     * @return $this
+     */
+    final public function format(string $format): self
+    {
+        $this->route->addDefaults(['_format' => $format]);
+
+        return $this;
+    }
+
+    /**
+     * Adds the "_stateless" entry to defaults.
+     *
+     * @return $this
+     */
+    final public function stateless(bool $stateless = true): self
+    {
+        $this->route->addDefaults(['_stateless' => $stateless]);
+
+        return $this;
+    }
 }