123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208 |
- <?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\Kernel;
- use Symfony\Component\Config\Loader\LoaderInterface;
- use Symfony\Component\DependencyInjection\ContainerBuilder;
- use Symfony\Component\DependencyInjection\Loader\Configurator\AbstractConfigurator;
- use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
- use Symfony\Component\DependencyInjection\Loader\PhpFileLoader as ContainerPhpFileLoader;
- use Symfony\Component\DependencyInjection\Reference;
- use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;
- use Symfony\Component\Routing\Loader\PhpFileLoader as RoutingPhpFileLoader;
- use Symfony\Component\Routing\RouteCollection;
- use Symfony\Component\Routing\RouteCollectionBuilder;
- /**
- * A Kernel that provides configuration hooks.
- *
- * @author Ryan Weaver <ryan@knpuniversity.com>
- * @author Fabien Potencier <fabien@symfony.com>
- *
- * @method void configureRoutes(RoutingConfigurator $routes)
- * @method void configureContainer(ContainerConfigurator $container)
- */
- trait MicroKernelTrait
- {
- /**
- * Adds or imports routes into your application.
- *
- * $routes->import($this->getProjectDir().'/config/*.{yaml,php}');
- * $routes
- * ->add('admin_dashboard', '/admin')
- * ->controller('App\Controller\AdminController::dashboard')
- * ;
- */
- //abstract protected function configureRoutes(RoutingConfigurator $routes): void;
- /**
- * Configures the container.
- *
- * You can register extensions:
- *
- * $c->extension('framework', [
- * 'secret' => '%secret%'
- * ]);
- *
- * Or services:
- *
- * $c->services()->set('halloween', 'FooBundle\HalloweenProvider');
- *
- * Or parameters:
- *
- * $c->parameters()->set('halloween', 'lot of fun');
- */
- //abstract protected function configureContainer(ContainerConfigurator $c): void;
- /**
- * {@inheritdoc}
- */
- public function getCacheDir(): string
- {
- if (isset($_SERVER['APP_CACHE_DIR'])) {
- return $_SERVER['APP_CACHE_DIR'].'/'.$this->environment;
- }
- return parent::getCacheDir();
- }
- /**
- * {@inheritdoc}
- */
- public function getLogDir(): string
- {
- return $_SERVER['APP_LOG_DIR'] ?? parent::getLogDir();
- }
- /**
- * {@inheritdoc}
- */
- public function registerBundles(): iterable
- {
- $contents = require $this->getProjectDir().'/config/bundles.php';
- foreach ($contents as $class => $envs) {
- if ($envs[$this->environment] ?? $envs['all'] ?? false) {
- yield new $class();
- }
- }
- }
- /**
- * {@inheritdoc}
- */
- public function registerContainerConfiguration(LoaderInterface $loader)
- {
- $loader->load(function (ContainerBuilder $container) use ($loader) {
- $container->loadFromExtension('framework', [
- 'router' => [
- 'resource' => 'kernel::loadRoutes',
- 'type' => 'service',
- ],
- ]);
- $kernelClass = false !== strpos(static::class, "@anonymous\0") ? parent::class : static::class;
- if (!$container->hasDefinition('kernel')) {
- $container->register('kernel', $kernelClass)
- ->addTag('controller.service_arguments')
- ->setAutoconfigured(true)
- ->setSynthetic(true)
- ->setPublic(true)
- ;
- }
- $kernelDefinition = $container->getDefinition('kernel');
- $kernelDefinition->addTag('routing.route_loader');
- $container->addObjectResource($this);
- $container->fileExists($this->getProjectDir().'/config/bundles.php');
- try {
- $configureContainer = new \ReflectionMethod($this, 'configureContainer');
- } catch (\ReflectionException $e) {
- throw new \LogicException(sprintf('"%s" uses "%s", but does not implement the required method "protected function configureContainer(ContainerConfigurator $c): void".', get_debug_type($this), MicroKernelTrait::class), 0, $e);
- }
- $configuratorClass = $configureContainer->getNumberOfParameters() > 0 && ($type = $configureContainer->getParameters()[0]->getType()) instanceof \ReflectionNamedType && !$type->isBuiltin() ? $type->getName() : null;
- if ($configuratorClass && !is_a(ContainerConfigurator::class, $configuratorClass, true)) {
- $this->configureContainer($container, $loader);
- return;
- }
- // the user has opted into using the ContainerConfigurator
- /* @var ContainerPhpFileLoader $kernelLoader */
- $kernelLoader = $loader->getResolver()->resolve($file = $configureContainer->getFileName());
- $kernelLoader->setCurrentDir(\dirname($file));
- $instanceof = &\Closure::bind(function &() { return $this->instanceof; }, $kernelLoader, $kernelLoader)();
- $valuePreProcessor = AbstractConfigurator::$valuePreProcessor;
- AbstractConfigurator::$valuePreProcessor = function ($value) {
- return $this === $value ? new Reference('kernel') : $value;
- };
- try {
- $this->configureContainer(new ContainerConfigurator($container, $kernelLoader, $instanceof, $file, $file), $loader);
- } finally {
- $instanceof = [];
- $kernelLoader->registerAliasesForSinglyImplementedInterfaces();
- AbstractConfigurator::$valuePreProcessor = $valuePreProcessor;
- }
- $container->setAlias($kernelClass, 'kernel')->setPublic(true);
- });
- }
- /**
- * @internal
- *
- * @return RouteCollection
- */
- public function loadRoutes(LoaderInterface $loader)
- {
- $file = (new \ReflectionObject($this))->getFileName();
- /* @var RoutingPhpFileLoader $kernelLoader */
- $kernelLoader = $loader->getResolver()->resolve($file, 'php');
- $kernelLoader->setCurrentDir(\dirname($file));
- $collection = new RouteCollection();
- try {
- $configureRoutes = new \ReflectionMethod($this, 'configureRoutes');
- } catch (\ReflectionException $e) {
- throw new \LogicException(sprintf('"%s" uses "%s", but does not implement the required method "protected function configureRoutes(RoutingConfigurator $routes): void".', get_debug_type($this), MicroKernelTrait::class), 0, $e);
- }
- $configuratorClass = $configureRoutes->getNumberOfParameters() > 0 && ($type = $configureRoutes->getParameters()[0]->getType()) && !$type->isBuiltin() ? $type->getName() : null;
- if ($configuratorClass && !is_a(RoutingConfigurator::class, $configuratorClass, true)) {
- trigger_deprecation('symfony/framework-bundle', '5.1', 'Using type "%s" for argument 1 of method "%s:configureRoutes()" is deprecated, use "%s" instead.', RouteCollectionBuilder::class, self::class, RoutingConfigurator::class);
- $routes = new RouteCollectionBuilder($loader);
- $this->configureRoutes($routes);
- return $routes->build();
- }
- $this->configureRoutes(new RoutingConfigurator($collection, $kernelLoader, $file, $file));
- foreach ($collection as $route) {
- $controller = $route->getDefault('_controller');
- if (\is_array($controller) && [0, 1] === array_keys($controller) && $this === $controller[0]) {
- $route->setDefault('_controller', ['kernel', $controller[1]]);
- }
- }
- return $collection;
- }
- }
|