vendor/symfony/framework-bundle/Kernel/MicroKernelTrait.php line 202

  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Bundle\FrameworkBundle\Kernel;
  14. use Symfony\Component\Config\Loader\LoaderInterface;
  15. use Symfony\Component\DependencyInjection\ContainerBuilder;
  16. use Symfony\Component\DependencyInjection\Loader\Configurator\AbstractConfigurator;
  17. use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
  18. use Symfony\Component\DependencyInjection\Loader\PhpFileLoader as ContainerPhpFileLoader;
  19. use Symfony\Component\DependencyInjection\Reference;
  20. use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;
  21. use Symfony\Component\Routing\Loader\PhpFileLoader as RoutingPhpFileLoader;
  22. use Symfony\Component\Routing\RouteCollection;
  24. /**
  25.  * A Kernel that provides configuration hooks.
  26.  *
  27.  * @author Ryan Weaver <ryan@knpuniversity.com>
  28.  * @author Fabien Potencier <fabien@symfony.com>
  29.  */
  30. trait MicroKernelTrait
  31. {
  32.     /**
  33.      * Configures the container.
  34.      *
  35.      * You can register extensions:
  36.      *
  37.      *     $container->extension('framework', [
  38.      *         'secret' => '%secret%'
  39.      *     ]);
  40.      *
  41.      * Or services:
  42.      *
  43.      *     $container->services()->set('halloween', 'FooBundle\HalloweenProvider');
  44.      *
  45.      * Or parameters:
  46.      *
  47.      *     $container->parameters()->set('halloween', 'lot of fun');
  48.      */
  49.     private function configureContainer(ContainerConfigurator $container, LoaderInterface $loader, ContainerBuilder $builder): void
  50.     {
  51.         $configDir = $this->getConfigDir();
  53.         $container->import($configDir.'/{packages}/*.{php,yaml}');
  54.         $container->import($configDir.'/{packages}/'.$this->environment.'/*.{php,yaml}');
  56.         if (is_file($configDir.'/services.yaml')) {
  57.             $container->import($configDir.'/services.yaml');
  58.             $container->import($configDir.'/{services}_'.$this->environment.'.yaml');
  59.         } else {
  60.             $container->import($configDir.'/{services}.php');
  61.         }
  62.     }
  64.     /**
  65.      * Adds or imports routes into your application.
  66.      *
  67.      *     $routes->import($this->getConfigDir().'/*.{yaml,php}');
  68.      *     $routes
  69.      *         ->add('admin_dashboard', '/admin')
  70.      *         ->controller('App\Controller\AdminController::dashboard')
  71.      *     ;
  72.      */
  73.     private function configureRoutes(RoutingConfigurator $routes): void
  74.     {
  75.         $configDir = $this->getConfigDir();
  77.         $routes->import($configDir.'/{routes}/'.$this->environment.'/*.{php,yaml}');
  78.         $routes->import($configDir.'/{routes}/*.{php,yaml}');
  80.         if (is_file($configDir.'/routes.yaml')) {
  81.             $routes->import($configDir.'/routes.yaml');
  82.         } else {
  83.             $routes->import($configDir.'/{routes}.php');
  84.         }
  86.         if (false !== ($fileName = (new \ReflectionObject($this))->getFileName())) {
  87.             $routes->import($fileName, 'annotation');
  88.         }
  89.     }
  91.     /**
  92.      * Gets the path to the configuration directory.
  93.      */
  94.     private function getConfigDir(): string
  95.     {
  96.         return $this->getProjectDir().'/config';
  97.     }
  99.     /**
  100.      * Gets the path to the bundles configuration file.
  101.      */
  102.     private function getBundlesPath(): string
  103.     {
  104.         return $this->getConfigDir().'/bundles.php';
  105.     }
  107.     public function getCacheDir(): string
  108.     {
  109.         if (isset($_SERVER['APP_CACHE_DIR'])) {
  110.             return $_SERVER['APP_CACHE_DIR'].'/'.$this->environment;
  111.         }
  113.         return parent::getCacheDir();
  114.     }
  116.     public function getLogDir(): string
  117.     {
  118.         return $_SERVER['APP_LOG_DIR'] ?? parent::getLogDir();
  119.     }
  121.     public function registerBundles(): iterable
  122.     {
  123.         $contents = require $this->getBundlesPath();
  124.         foreach ($contents as $class => $envs) {
  125.             if ($envs[$this->environment] ?? $envs['all'] ?? false) {
  126.                 yield new $class();
  127.             }
  128.         }
  129.     }
  131.     public function registerContainerConfiguration(LoaderInterface $loader)
  132.     {
  133.         $loader->load(function (ContainerBuilder $container) use ($loader) {
  134.             $container->loadFromExtension('framework', [
  135.                 'router' => [
  136.                     'resource' => 'kernel::loadRoutes',
  137.                     'type' => 'service',
  138.                 ],
  139.             ]);
  141.             $kernelClass = str_contains(static::class, "@anonymous\0") ? parent::class : static::class;
  143.             if (!$container->hasDefinition('kernel')) {
  144.                 $container->register('kernel', $kernelClass)
  145.                     ->addTag('controller.service_arguments')
  146.                     ->setAutoconfigured(true)
  147.                     ->setSynthetic(true)
  148.                     ->setPublic(true)
  149.                 ;
  150.             }
  152.             $kernelDefinition = $container->getDefinition('kernel');
  153.             $kernelDefinition->addTag('routing.route_loader');
  155.             $container->addObjectResource($this);
  156.             $container->fileExists($this->getBundlesPath());
  158.             $configureContainer = new \ReflectionMethod($this, 'configureContainer');
  159.             $configuratorClass = $configureContainer->getNumberOfParameters() > 0 && ($type = $configureContainer->getParameters()[0]->getType()) instanceof \ReflectionNamedType && !$type->isBuiltin() ? $type->getName() : null;
  161.             if ($configuratorClass && !is_a(ContainerConfigurator::class, $configuratorClass, true)) {
  162.                 $configureContainer->getClosure($this)($container, $loader);
  164.                 return;
  165.             }
  167.             $file = (new \ReflectionObject($this))->getFileName();
  168.             /* @var ContainerPhpFileLoader $kernelLoader */
  169.             $kernelLoader = $loader->getResolver()->resolve($file);
  170.             $kernelLoader->setCurrentDir(\dirname($file));
  171.             $instanceof = &\Closure::bind(function &() { return $this->instanceof; }, $kernelLoader, $kernelLoader)();
  173.             $valuePreProcessor = AbstractConfigurator::$valuePreProcessor;
  174.             AbstractConfigurator::$valuePreProcessor = function ($value) {
  175.                 return $this === $value ? new Reference('kernel') : $value;
  176.             };
  178.             try {
  179.                 $configureContainer->getClosure($this)(new ContainerConfigurator($container, $kernelLoader, $instanceof, $file, $file, $this->getEnvironment()), $loader, $container);
  180.             } finally {
  181.                 $instanceof = [];
  182.                 $kernelLoader->registerAliasesForSinglyImplementedInterfaces();
  183.                 AbstractConfigurator::$valuePreProcessor = $valuePreProcessor;
  184.             }
  186.             $container->setAlias($kernelClass, 'kernel')->setPublic(true);
  187.         });
  188.     }
  190.     /**
  191.      * @internal
  192.      */
  193.     public function loadRoutes(LoaderInterface $loader): RouteCollection
  194.     {
  195.         $file = (new \ReflectionObject($this))->getFileName();
  196.         /* @var RoutingPhpFileLoader $kernelLoader */
  197.         $kernelLoader = $loader->getResolver()->resolve($file, 'php');
  198.         $kernelLoader->setCurrentDir(\dirname($file));
  199.         $collection = new RouteCollection();
  201.         $configureRoutes = new \ReflectionMethod($this, 'configureRoutes');
  202.         $configureRoutes->getClosure($this)(new RoutingConfigurator($collection, $kernelLoader, $file, $file, $this->getEnvironment()));
  204.         foreach ($collection as $route) {
  205.             $controller = $route->getDefault('_controller');
  207.             if (\is_array($controller) && [0, 1] === array_keys($controller) && $this === $controller[0]) {
  208.                 $route->setDefault('_controller', ['kernel', $controller[1]]);
  209.             } elseif ($controller instanceof \Closure && $this === ($r = new \ReflectionFunction($controller))->getClosureThis() && !str_contains($r->name, '{closure}')) {
  210.                 $route->setDefault('_controller', ['kernel', $r->name]);
  211.             }
  212.         }
  214.         return $collection;
  215.     }
  216. }