[FrameworkBundle] Allow using a ContainerConfigurator in MicroKernelTrait::configureContainer()
This commit is contained in:
parent
44458126b5
commit
cf45eeccfc
|
@ -4,8 +4,7 @@ UPGRADE FROM 5.0 to 5.1
|
||||||
FrameworkBundle
|
FrameworkBundle
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
* Marked `MicroKernelTrait::configureRoutes()` as `@internal` and `@final`.
|
* Deprecated passing a `RouteCollectionBuiler` to `MicroKernelTrait::configureRoutes()`, type-hint `RoutingConfigurator` instead
|
||||||
* Deprecated not overriding `MicroKernelTrait::configureRouting()`.
|
|
||||||
|
|
||||||
HttpFoundation
|
HttpFoundation
|
||||||
--------------
|
--------------
|
||||||
|
|
|
@ -4,8 +4,7 @@ UPGRADE FROM 5.x to 6.0
|
||||||
FrameworkBundle
|
FrameworkBundle
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
* Removed `MicroKernelTrait::configureRoutes()`.
|
* `MicroKernelTrait::configureRoutes()` is now always called with a `RoutingConfigurator`
|
||||||
* Made `MicroKernelTrait::configureRouting()` abstract.
|
|
||||||
|
|
||||||
HttpFoundation
|
HttpFoundation
|
||||||
--------------
|
--------------
|
||||||
|
|
|
@ -4,10 +4,10 @@ CHANGELOG
|
||||||
5.1.0
|
5.1.0
|
||||||
-----
|
-----
|
||||||
|
|
||||||
* Marked `MicroKernelTrait::configureRoutes()` as `@internal` and `@final`.
|
* Made `MicroKernelTrait::configureContainer()` compatible with `ContainerConfigurator`
|
||||||
* Deprecated not overriding `MicroKernelTrait::configureRouting()`.
|
|
||||||
* Added a new `mailer.message_bus` option to configure or disable the message bus to use to send mails.
|
* Added a new `mailer.message_bus` option to configure or disable the message bus to use to send mails.
|
||||||
* Added flex-compatible default implementations for `MicroKernelTrait::registerBundles()` and `getProjectDir()`
|
* Added flex-compatible default implementations for `MicroKernelTrait::registerBundles()` and `getProjectDir()`
|
||||||
|
* Deprecated passing a `RouteCollectionBuiler` to `MicroKernelTrait::configureRoutes()`, type-hint `RoutingConfigurator` instead
|
||||||
|
|
||||||
5.0.0
|
5.0.0
|
||||||
-----
|
-----
|
||||||
|
|
|
@ -13,8 +13,10 @@ namespace Symfony\Bundle\FrameworkBundle\Kernel;
|
||||||
|
|
||||||
use Symfony\Component\Config\Loader\LoaderInterface;
|
use Symfony\Component\Config\Loader\LoaderInterface;
|
||||||
use Symfony\Component\DependencyInjection\ContainerBuilder;
|
use Symfony\Component\DependencyInjection\ContainerBuilder;
|
||||||
|
use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
|
||||||
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
|
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
|
||||||
use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;
|
use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;
|
||||||
|
use Symfony\Component\Routing\RouteCollection;
|
||||||
use Symfony\Component\Routing\RouteCollectionBuilder;
|
use Symfony\Component\Routing\RouteCollectionBuilder;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -25,20 +27,6 @@ use Symfony\Component\Routing\RouteCollectionBuilder;
|
||||||
*/
|
*/
|
||||||
trait MicroKernelTrait
|
trait MicroKernelTrait
|
||||||
{
|
{
|
||||||
/**
|
|
||||||
* Add or import routes into your application.
|
|
||||||
*
|
|
||||||
* $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
|
|
||||||
*/
|
|
||||||
protected function configureRoutes(RouteCollectionBuilder $routes)
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Adds or imports routes into your application.
|
* Adds or imports routes into your application.
|
||||||
*
|
*
|
||||||
|
@ -48,29 +36,26 @@ trait MicroKernelTrait
|
||||||
* ->controller('App\Controller\AdminController::dashboard')
|
* ->controller('App\Controller\AdminController::dashboard')
|
||||||
* ;
|
* ;
|
||||||
*/
|
*/
|
||||||
protected function configureRouting(RoutingConfigurator $routes): void
|
abstract protected function configureRoutes(RoutingConfigurator $routes);
|
||||||
{
|
|
||||||
@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.
|
* Configures the container.
|
||||||
*
|
*
|
||||||
* You can register extensions:
|
* You can register extensions:
|
||||||
*
|
*
|
||||||
* $c->loadFromExtension('framework', [
|
* $c->extension('framework', [
|
||||||
* 'secret' => '%secret%'
|
* 'secret' => '%secret%'
|
||||||
* ]);
|
* ]);
|
||||||
*
|
*
|
||||||
* Or services:
|
* Or services:
|
||||||
*
|
*
|
||||||
* $c->register('halloween', 'FooBundle\HalloweenProvider');
|
* $c->services()->set('halloween', 'FooBundle\HalloweenProvider');
|
||||||
*
|
*
|
||||||
* Or parameters:
|
* Or parameters:
|
||||||
*
|
*
|
||||||
* $c->setParameter('halloween', 'lot of fun');
|
* $c->parameters()->set('halloween', 'lot of fun');
|
||||||
*/
|
*/
|
||||||
abstract protected function configureContainer(ContainerBuilder $c, LoaderInterface $loader);
|
abstract protected function configureContainer(ContainerConfigurator $c);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* {@inheritdoc}
|
* {@inheritdoc}
|
||||||
|
@ -120,9 +105,31 @@ trait MicroKernelTrait
|
||||||
$kernelDefinition->addTag('kernel.event_subscriber');
|
$kernelDefinition->addTag('kernel.event_subscriber');
|
||||||
}
|
}
|
||||||
|
|
||||||
$this->configureContainer($container, $loader);
|
|
||||||
$container->addObjectResource($this);
|
$container->addObjectResource($this);
|
||||||
$container->fileExists($this->getProjectDir().'/config/bundles.php');
|
$container->fileExists($this->getProjectDir().'/config/bundles.php');
|
||||||
|
|
||||||
|
try {
|
||||||
|
$this->configureContainer($container, $loader);
|
||||||
|
|
||||||
|
return;
|
||||||
|
} catch (\TypeError $e) {
|
||||||
|
$file = $e->getFile();
|
||||||
|
|
||||||
|
if (0 !== strpos($e->getMessage(), sprintf('Argument 1 passed to %s::configureContainer() must be an instance of %s,', static::class, ContainerConfigurator::class))) {
|
||||||
|
throw $e;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
$kernelLoader = $loader->getResolver()->resolve($file);
|
||||||
|
$kernelLoader->setCurrentDir(\dirname($file));
|
||||||
|
$instanceof = &\Closure::bind(function &() { return $this->instanceof; }, $kernelLoader, $kernelLoader)();
|
||||||
|
|
||||||
|
try {
|
||||||
|
$this->configureContainer(new ContainerConfigurator($container, $kernelLoader, $instanceof, $file, $file), $loader);
|
||||||
|
} finally {
|
||||||
|
$instanceof = [];
|
||||||
|
$kernelLoader->registerAliasesForSinglyImplementedInterfaces();
|
||||||
|
}
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -131,17 +138,26 @@ trait MicroKernelTrait
|
||||||
*/
|
*/
|
||||||
public function loadRoutes(LoaderInterface $loader)
|
public function loadRoutes(LoaderInterface $loader)
|
||||||
{
|
{
|
||||||
$routes = new RouteCollectionBuilder($loader);
|
|
||||||
$this->configureRoutes($routes);
|
|
||||||
$collection = $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();
|
$file = (new \ReflectionObject($this))->getFileName();
|
||||||
$this->configureRouting(new RoutingConfigurator($collection, $loader, null, $file));
|
$kernelLoader = $loader->getResolver()->resolve($file);
|
||||||
|
$kernelLoader->setCurrentDir(\dirname($file));
|
||||||
|
$collection = new RouteCollection();
|
||||||
|
|
||||||
|
try {
|
||||||
|
$this->configureRoutes(new RoutingConfigurator($collection, $kernelLoader, $file, $file));
|
||||||
|
|
||||||
return $collection;
|
return $collection;
|
||||||
|
} catch (\TypeError $e) {
|
||||||
|
if (0 !== strpos($e->getMessage(), sprintf('Argument 1 passed to %s::configureRoutes() must be an instance of %s,', static::class, RouteCollectionBuilder::class))) {
|
||||||
|
throw $e;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@trigger_error(sprintf('Using type "%s" for argument 1 of method "%s:configureRoutes()" is deprecated since Symfony 5.1, use "%s" instead.', RouteCollectionBuilder::class, self::class, RoutingConfigurator::class), E_USER_DEPRECATED);
|
||||||
|
|
||||||
|
$routes = new RouteCollectionBuilder($loader);
|
||||||
|
$this->configureRoutes($routes);
|
||||||
|
|
||||||
|
return $routes->build();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -80,7 +80,7 @@ class ConcreteMicroKernel extends Kernel implements EventSubscriberInterface
|
||||||
$fs->remove($this->cacheDir);
|
$fs->remove($this->cacheDir);
|
||||||
}
|
}
|
||||||
|
|
||||||
protected function configureRouting(RoutingConfigurator $routes): void
|
protected function configureRoutes(RoutingConfigurator $routes): void
|
||||||
{
|
{
|
||||||
$routes->add('halloween', '/')->controller('kernel::halloweenAction');
|
$routes->add('halloween', '/')->controller('kernel::halloweenAction');
|
||||||
$routes->add('danger', '/danger')->controller('kernel::dangerousAction');
|
$routes->add('danger', '/danger')->controller('kernel::dangerousAction');
|
||||||
|
|
|
@ -19,18 +19,6 @@ use Symfony\Component\HttpFoundation\Request;
|
||||||
|
|
||||||
class MicroKernelTraitTest extends TestCase
|
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()
|
public function test()
|
||||||
{
|
{
|
||||||
$kernel = new ConcreteMicroKernel('test', false);
|
$kernel = new ConcreteMicroKernel('test', false);
|
||||||
|
|
|
@ -1,74 +0,0 @@
|
||||||
<?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/polyfill-mbstring": "~1.0",
|
||||||
"symfony/filesystem": "^4.4|^5.0",
|
"symfony/filesystem": "^4.4|^5.0",
|
||||||
"symfony/finder": "^4.4|^5.0",
|
"symfony/finder": "^4.4|^5.0",
|
||||||
"symfony/routing": "^5.1"
|
"symfony/routing": "^5.0"
|
||||||
},
|
},
|
||||||
"require-dev": {
|
"require-dev": {
|
||||||
"doctrine/annotations": "~1.7",
|
"doctrine/annotations": "~1.7",
|
||||||
|
|
|
@ -5,7 +5,6 @@ CHANGELOG
|
||||||
-----
|
-----
|
||||||
|
|
||||||
* Deprecated `RouteCollectionBuilder` in favor of `RoutingConfigurator`.
|
* Deprecated `RouteCollectionBuilder` in favor of `RoutingConfigurator`.
|
||||||
* Added support for a generic loader to `RoutingConfigurator`.
|
|
||||||
|
|
||||||
5.0.0
|
5.0.0
|
||||||
-----
|
-----
|
||||||
|
|
|
@ -11,9 +11,7 @@
|
||||||
|
|
||||||
namespace Symfony\Component\Routing\Loader\Configurator;
|
namespace Symfony\Component\Routing\Loader\Configurator;
|
||||||
|
|
||||||
use Symfony\Component\Config\Exception\LoaderLoadException;
|
use Symfony\Component\Routing\Loader\PhpFileLoader;
|
||||||
use Symfony\Component\Config\Loader\FileLoader;
|
|
||||||
use Symfony\Component\Config\Loader\LoaderInterface;
|
|
||||||
use Symfony\Component\Routing\RouteCollection;
|
use Symfony\Component\Routing\RouteCollection;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -27,7 +25,7 @@ class RoutingConfigurator
|
||||||
private $path;
|
private $path;
|
||||||
private $file;
|
private $file;
|
||||||
|
|
||||||
public function __construct(RouteCollection $collection, LoaderInterface $loader, ?string $path, string $file)
|
public function __construct(RouteCollection $collection, PhpFileLoader $loader, string $path, string $file)
|
||||||
{
|
{
|
||||||
$this->collection = $collection;
|
$this->collection = $collection;
|
||||||
$this->loader = $loader;
|
$this->loader = $loader;
|
||||||
|
@ -40,7 +38,9 @@ class RoutingConfigurator
|
||||||
*/
|
*/
|
||||||
final public function import($resource, string $type = null, bool $ignoreErrors = false, $exclude = null): ImportConfigurator
|
final public function import($resource, string $type = null, bool $ignoreErrors = false, $exclude = null): ImportConfigurator
|
||||||
{
|
{
|
||||||
$imported = $this->load($resource, $type, $ignoreErrors, $exclude) ?: [];
|
$this->loader->setCurrentDir(\dirname($this->path));
|
||||||
|
|
||||||
|
$imported = $this->loader->import($resource, $type, $ignoreErrors, $this->file, $exclude) ?: [];
|
||||||
if (!\is_array($imported)) {
|
if (!\is_array($imported)) {
|
||||||
return new ImportConfigurator($this->collection, $imported);
|
return new ImportConfigurator($this->collection, $imported);
|
||||||
}
|
}
|
||||||
|
@ -57,34 +57,4 @@ class RoutingConfigurator
|
||||||
{
|
{
|
||||||
return new CollectionConfigurator($this->collection, $name);
|
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);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
|
@ -14,6 +14,9 @@ namespace Symfony\Component\Routing;
|
||||||
use Symfony\Component\Config\Exception\LoaderLoadException;
|
use Symfony\Component\Config\Exception\LoaderLoadException;
|
||||||
use Symfony\Component\Config\Loader\LoaderInterface;
|
use Symfony\Component\Config\Loader\LoaderInterface;
|
||||||
use Symfony\Component\Config\Resource\ResourceInterface;
|
use Symfony\Component\Config\Resource\ResourceInterface;
|
||||||
|
use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;
|
||||||
|
|
||||||
|
@trigger_error(sprintf('The "%s" class is deprecated since Symfony 5.1, use "%s" instead.', RouteCollectionBuilder::class, RoutingConfigurator::class), E_USER_DEPRECATED);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Helps add and import routes into a RouteCollection.
|
* Helps add and import routes into a RouteCollection.
|
||||||
|
|
Reference in New Issue