[Routing] Deprecate RouteCollectionBuilder
This commit is contained in:
parent
9aa7492fdc
commit
e641cbdd46
13
UPGRADE-5.1.md
Normal file
13
UPGRADE-5.1.md
Normal file
@ -0,0 +1,13 @@
|
||||
UPGRADE FROM 5.0 to 5.1
|
||||
=======================
|
||||
|
||||
FrameworkBundle
|
||||
---------------
|
||||
|
||||
* Marked `MicroKernelTrait::configureRoutes()` as `@internal` and `@final`.
|
||||
* Deprecated not overriding `MicroKernelTrait::configureRouting()`.
|
||||
|
||||
Routing
|
||||
-------
|
||||
|
||||
* Deprecated `RouteCollectionBuilder` in favor of `RoutingConfigurator`.
|
13
UPGRADE-6.0.md
Normal file
13
UPGRADE-6.0.md
Normal file
@ -0,0 +1,13 @@
|
||||
UPGRADE FROM 5.x to 6.0
|
||||
=======================
|
||||
|
||||
FrameworkBundle
|
||||
---------------
|
||||
|
||||
* Removed `MicroKernelTrait::configureRoutes()`.
|
||||
* Made `MicroKernelTrait::configureRouting()` abstract.
|
||||
|
||||
Routing
|
||||
-------
|
||||
|
||||
* Removed `RouteCollectionBuilder`.
|
@ -1,6 +1,12 @@
|
||||
CHANGELOG
|
||||
=========
|
||||
|
||||
5.1.0
|
||||
-----
|
||||
|
||||
* Marked `MicroKernelTrait::configureRoutes()` as `@internal` and `@final`.
|
||||
* Deprecated not overriding `MicroKernelTrait::configureRouting()`.
|
||||
|
||||
5.0.0
|
||||
-----
|
||||
|
||||
|
@ -14,6 +14,7 @@ namespace Symfony\Bundle\FrameworkBundle\Kernel;
|
||||
use Symfony\Component\Config\Loader\LoaderInterface;
|
||||
use Symfony\Component\DependencyInjection\ContainerBuilder;
|
||||
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
|
||||
use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;
|
||||
use Symfony\Component\Routing\RouteCollectionBuilder;
|
||||
|
||||
/**
|
||||
@ -29,8 +30,28 @@ trait MicroKernelTrait
|
||||
*
|
||||
* $routes->import('config/routing.yml');
|
||||
* $routes->add('/admin', 'App\Controller\AdminController::dashboard', 'admin_dashboard');
|
||||
*
|
||||
* @final since Symfony 5.1, override configureRouting() instead
|
||||
*
|
||||
* @internal since Symfony 5.1, use configureRouting() instead
|
||||
*/
|
||||
abstract protected function configureRoutes(RouteCollectionBuilder $routes);
|
||||
protected function configureRoutes(RouteCollectionBuilder $routes)
|
||||
{
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds or imports routes into your application.
|
||||
*
|
||||
* $routes->import($this->getProjectDir().'/config/*.{yaml,php}');
|
||||
* $routes
|
||||
* ->add('admin_dashboard', '/admin')
|
||||
* ->controller('App\Controller\AdminController::dashboard')
|
||||
* ;
|
||||
*/
|
||||
protected function configureRouting(RoutingConfigurator $routes): void
|
||||
{
|
||||
@trigger_error(sprintf('Not overriding the "%s()" method is deprecated since Symfony 5.1 and will trigger a fatal error in 6.0.', __METHOD__), E_USER_DEPRECATED);
|
||||
}
|
||||
|
||||
/**
|
||||
* Configures the container.
|
||||
@ -91,7 +112,15 @@ trait MicroKernelTrait
|
||||
{
|
||||
$routes = new RouteCollectionBuilder($loader);
|
||||
$this->configureRoutes($routes);
|
||||
$collection = $routes->build();
|
||||
|
||||
return $routes->build();
|
||||
if (0 !== \count($collection)) {
|
||||
@trigger_error(sprintf('Adding routes via the "%s:configureRoutes()" method is deprecated since Symfony 5.1 and will have no effect in 6.0; use "configureRouting()" instead.', self::class), E_USER_DEPRECATED);
|
||||
}
|
||||
|
||||
$file = (new \ReflectionObject($this))->getFileName();
|
||||
$this->configureRouting(new RoutingConfigurator($collection, $loader, null, $file));
|
||||
|
||||
return $collection;
|
||||
}
|
||||
}
|
||||
|
@ -22,7 +22,7 @@ use Symfony\Component\HttpFoundation\Response;
|
||||
use Symfony\Component\HttpKernel\Event\ExceptionEvent;
|
||||
use Symfony\Component\HttpKernel\Kernel;
|
||||
use Symfony\Component\HttpKernel\KernelEvents;
|
||||
use Symfony\Component\Routing\RouteCollectionBuilder;
|
||||
use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;
|
||||
|
||||
class ConcreteMicroKernel extends Kernel implements EventSubscriberInterface
|
||||
{
|
||||
@ -80,10 +80,10 @@ class ConcreteMicroKernel extends Kernel implements EventSubscriberInterface
|
||||
$fs->remove($this->cacheDir);
|
||||
}
|
||||
|
||||
protected function configureRoutes(RouteCollectionBuilder $routes)
|
||||
protected function configureRouting(RoutingConfigurator $routes): void
|
||||
{
|
||||
$routes->add('/', 'kernel::halloweenAction');
|
||||
$routes->add('/danger', 'kernel::dangerousAction');
|
||||
$routes->add('halloween', '/')->controller('kernel::halloweenAction');
|
||||
$routes->add('danger', '/danger')->controller('kernel::dangerousAction');
|
||||
}
|
||||
|
||||
protected function configureContainer(ContainerBuilder $c, LoaderInterface $loader)
|
||||
|
@ -19,6 +19,18 @@ use Symfony\Component\HttpFoundation\Request;
|
||||
|
||||
class MicroKernelTraitTest extends TestCase
|
||||
{
|
||||
/**
|
||||
* @group legacy
|
||||
* @expectedDeprecation Adding routes via the "Symfony\Bundle\FrameworkBundle\Tests\Kernel\MicroKernelWithConfigureRoutes:configureRoutes()" method is deprecated since Symfony 5.1 and will have no effect in 6.0; use "configureRouting()" instead.
|
||||
* @expectedDeprecation Not overriding the "Symfony\Bundle\FrameworkBundle\Kernel\MicroKernelTrait::configureRouting()" method is deprecated since Symfony 5.1 and will trigger a fatal error in 6.0.
|
||||
*/
|
||||
public function testConfigureRoutingDeprecated()
|
||||
{
|
||||
$kernel = new MicroKernelWithConfigureRoutes('test', false);
|
||||
$kernel->boot();
|
||||
$kernel->handle(Request::create('/'));
|
||||
}
|
||||
|
||||
public function test()
|
||||
{
|
||||
$kernel = new ConcreteMicroKernel('test', false);
|
||||
|
@ -0,0 +1,74 @@
|
||||
<?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\Bundle\FrameworkBundle\Tests\Kernel;
|
||||
|
||||
use Psr\Log\NullLogger;
|
||||
use Symfony\Bundle\FrameworkBundle\FrameworkBundle;
|
||||
use Symfony\Bundle\FrameworkBundle\Kernel\MicroKernelTrait;
|
||||
use Symfony\Component\Config\Loader\LoaderInterface;
|
||||
use Symfony\Component\DependencyInjection\ContainerBuilder;
|
||||
use Symfony\Component\Filesystem\Filesystem;
|
||||
use Symfony\Component\HttpKernel\Kernel;
|
||||
use Symfony\Component\Routing\RouteCollectionBuilder;
|
||||
|
||||
class MicroKernelWithConfigureRoutes extends Kernel
|
||||
{
|
||||
use MicroKernelTrait;
|
||||
|
||||
private $cacheDir;
|
||||
|
||||
public function registerBundles(): iterable
|
||||
{
|
||||
return [
|
||||
new FrameworkBundle(),
|
||||
];
|
||||
}
|
||||
|
||||
public function getCacheDir(): string
|
||||
{
|
||||
return $this->cacheDir = sys_get_temp_dir().'/sf_micro_kernel_with_configured_routes';
|
||||
}
|
||||
|
||||
public function getLogDir(): string
|
||||
{
|
||||
return $this->cacheDir;
|
||||
}
|
||||
|
||||
public function __sleep(): array
|
||||
{
|
||||
throw new \BadMethodCallException('Cannot serialize '.__CLASS__);
|
||||
}
|
||||
|
||||
public function __wakeup()
|
||||
{
|
||||
throw new \BadMethodCallException('Cannot unserialize '.__CLASS__);
|
||||
}
|
||||
|
||||
public function __destruct()
|
||||
{
|
||||
$fs = new Filesystem();
|
||||
$fs->remove($this->cacheDir);
|
||||
}
|
||||
|
||||
protected function configureRoutes(RouteCollectionBuilder $routes)
|
||||
{
|
||||
$routes->add('/', 'kernel::halloweenAction');
|
||||
}
|
||||
|
||||
protected function configureContainer(ContainerBuilder $c, LoaderInterface $loader)
|
||||
{
|
||||
$c->register('logger', NullLogger::class);
|
||||
$c->loadFromExtension('framework', [
|
||||
'secret' => '$ecret',
|
||||
]);
|
||||
}
|
||||
}
|
@ -27,7 +27,7 @@
|
||||
"symfony/polyfill-mbstring": "~1.0",
|
||||
"symfony/filesystem": "^4.4|^5.0",
|
||||
"symfony/finder": "^4.4|^5.0",
|
||||
"symfony/routing": "^5.0"
|
||||
"symfony/routing": "^5.1"
|
||||
},
|
||||
"require-dev": {
|
||||
"doctrine/annotations": "~1.7",
|
||||
|
@ -1,6 +1,12 @@
|
||||
CHANGELOG
|
||||
=========
|
||||
|
||||
5.1.0
|
||||
-----
|
||||
|
||||
* Deprecated `RouteCollectionBuilder` in favor of `RoutingConfigurator`.
|
||||
* Added support for a generic loader to `RoutingConfigurator`.
|
||||
|
||||
5.0.0
|
||||
-----
|
||||
|
||||
|
@ -11,7 +11,9 @@
|
||||
|
||||
namespace Symfony\Component\Routing\Loader\Configurator;
|
||||
|
||||
use Symfony\Component\Routing\Loader\PhpFileLoader;
|
||||
use Symfony\Component\Config\Exception\LoaderLoadException;
|
||||
use Symfony\Component\Config\Loader\FileLoader;
|
||||
use Symfony\Component\Config\Loader\LoaderInterface;
|
||||
use Symfony\Component\Routing\RouteCollection;
|
||||
|
||||
/**
|
||||
@ -25,7 +27,7 @@ class RoutingConfigurator
|
||||
private $path;
|
||||
private $file;
|
||||
|
||||
public function __construct(RouteCollection $collection, PhpFileLoader $loader, string $path, string $file)
|
||||
public function __construct(RouteCollection $collection, LoaderInterface $loader, ?string $path, string $file)
|
||||
{
|
||||
$this->collection = $collection;
|
||||
$this->loader = $loader;
|
||||
@ -38,9 +40,7 @@ class RoutingConfigurator
|
||||
*/
|
||||
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, $exclude) ?: [];
|
||||
$imported = $this->load($resource, $type, $ignoreErrors, $exclude) ?: [];
|
||||
if (!\is_array($imported)) {
|
||||
return new ImportConfigurator($this->collection, $imported);
|
||||
}
|
||||
@ -57,4 +57,34 @@ class RoutingConfigurator
|
||||
{
|
||||
return new CollectionConfigurator($this->collection, $name);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string|string[]|null $exclude
|
||||
*
|
||||
* @return RouteCollection|RouteCollection[]|null
|
||||
*/
|
||||
private function load($resource, ?string $type, bool $ignoreErrors, $exclude)
|
||||
{
|
||||
$loader = $this->loader;
|
||||
|
||||
if (!$loader->supports($resource, $type)) {
|
||||
if (null === $resolver = $loader->getResolver()) {
|
||||
throw new LoaderLoadException($resource, $this->file, null, null, $type);
|
||||
}
|
||||
|
||||
if (false === $loader = $resolver->resolve($resource, $type)) {
|
||||
throw new LoaderLoadException($resource, $this->file, null, null, $type);
|
||||
}
|
||||
}
|
||||
|
||||
if (!$loader instanceof FileLoader) {
|
||||
return $loader->load($resource, $type);
|
||||
}
|
||||
|
||||
if (null !== $this->path) {
|
||||
$this->loader->setCurrentDir(\dirname($this->path));
|
||||
}
|
||||
|
||||
return $this->loader->import($resource, $type, $ignoreErrors, $this->file, $exclude);
|
||||
}
|
||||
}
|
||||
|
@ -19,6 +19,8 @@ use Symfony\Component\Config\Resource\ResourceInterface;
|
||||
* Helps add and import routes into a RouteCollection.
|
||||
*
|
||||
* @author Ryan Weaver <ryan@knpuniversity.com>
|
||||
*
|
||||
* @deprecated since Symfony 5.1, use RoutingConfigurator instead
|
||||
*/
|
||||
class RouteCollectionBuilder
|
||||
{
|
||||
|
@ -19,6 +19,9 @@ use Symfony\Component\Routing\Route;
|
||||
use Symfony\Component\Routing\RouteCollection;
|
||||
use Symfony\Component\Routing\RouteCollectionBuilder;
|
||||
|
||||
/**
|
||||
* @group legacy
|
||||
*/
|
||||
class RouteCollectionBuilderTest extends TestCase
|
||||
{
|
||||
public function testImport()
|
||||
|
Reference in New Issue
Block a user