* * 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 * @author Fabien Potencier */ trait MicroKernelTrait { /** * Configures the container. * * You can register extensions: * * $container->extension('framework', [ * 'secret' => '%secret%' * ]); * * Or services: * * $container->services()->set('halloween', 'FooBundle\HalloweenProvider'); * * Or parameters: * * $container->parameters()->set('halloween', 'lot of fun'); */ private function configureContainer(ContainerConfigurator $container, LoaderInterface $loader, ContainerBuilder $builder): void { $configDir = $this->getConfigDir(); $container->import($configDir.'/{packages}/*.yaml'); $container->import($configDir.'/{packages}/'.$this->environment.'/*.yaml'); if (is_file($configDir.'/services.yaml')) { $container->import($configDir.'/services.yaml'); $container->import($configDir.'/{services}_'.$this->environment.'.yaml'); } else { $container->import($configDir.'/{services}.php'); } } /** * Adds or imports routes into your application. * * $routes->import($this->getConfigDir().'/*.{yaml,php}'); * $routes * ->add('admin_dashboard', '/admin') * ->controller('App\Controller\AdminController::dashboard') * ; */ private function configureRoutes(RoutingConfigurator $routes): void { $configDir = $this->getConfigDir(); $routes->import($configDir.'/{routes}/'.$this->environment.'/*.yaml'); $routes->import($configDir.'/{routes}/*.yaml'); if (is_file($configDir.'/routes.yaml')) { $routes->import($configDir.'/routes.yaml'); } else { $routes->import($configDir.'/{routes}.php'); } } /** * Gets the path to the configuration directory. */ private function getConfigDir(): string { return $this->getProjectDir().'/config'; } /** * Gets the path to the bundles configuration file. */ private function getBundlesPath(): string { return $this->getConfigDir().'/bundles.php'; } /** * {@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->getBundlesPath(); 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->getBundlesPath()); $configureContainer = new \ReflectionMethod($this, 'configureContainer'); $configuratorClass = $configureContainer->getNumberOfParameters() > 0 && ($type = $configureContainer->getParameters()[0]->getType()) instanceof \ReflectionNamedType && !$type->isBuiltin() ? $type->getName() : null; if ($configuratorClass && !is_a(ContainerConfigurator::class, $configuratorClass, true)) { $configureContainer->getClosure($this)($container, $loader); return; } $file = (new \ReflectionObject($this))->getFileName(); /* @var ContainerPhpFileLoader $kernelLoader */ $kernelLoader = $loader->getResolver()->resolve($file); $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 { $configureContainer->getClosure($this)(new ContainerConfigurator($container, $kernelLoader, $instanceof, $file, $file, $this->getEnvironment()), $loader, $container); } finally { $instanceof = []; $kernelLoader->registerAliasesForSinglyImplementedInterfaces(); AbstractConfigurator::$valuePreProcessor = $valuePreProcessor; } $container->setAlias($kernelClass, 'kernel')->setPublic(true); }); } /** * @internal */ public function loadRoutes(LoaderInterface $loader): RouteCollection { $file = (new \ReflectionObject($this))->getFileName(); /* @var RoutingPhpFileLoader $kernelLoader */ $kernelLoader = $loader->getResolver()->resolve($file, 'php'); $kernelLoader->setCurrentDir(\dirname($file)); $collection = new RouteCollection(); $configureRoutes = new \ReflectionMethod($this, 'configureRoutes'); $configuratorClass = $configureRoutes->getNumberOfParameters() > 0 && ($type = $configureRoutes->getParameters()[0]->getType()) instanceof \ReflectionNamedType && !$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(); } $configureRoutes->getClosure($this)(new RoutingConfigurator($collection, $kernelLoader, $file, $file, $this->getEnvironment())); 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; } }