vendor/symfony/http-kernel/Kernel.php line 198

Open in your IDE?
  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\Component\HttpKernel;
  14. use Symfony\Bridge\ProxyManager\LazyProxy\Instantiator\RuntimeInstantiator;
  15. use Symfony\Bridge\ProxyManager\LazyProxy\PhpDumper\ProxyDumper;
  16. use Symfony\Component\Config\ConfigCache;
  17. use Symfony\Component\Config\Loader\DelegatingLoader;
  18. use Symfony\Component\Config\Loader\LoaderResolver;
  19. use Symfony\Component\Debug\DebugClassLoader;
  20. use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
  21. use Symfony\Component\DependencyInjection\Compiler\PassConfig;
  22. use Symfony\Component\DependencyInjection\ContainerBuilder;
  23. use Symfony\Component\DependencyInjection\ContainerInterface;
  24. use Symfony\Component\DependencyInjection\Dumper\PhpDumper;
  25. use Symfony\Component\DependencyInjection\Loader\ClosureLoader;
  26. use Symfony\Component\DependencyInjection\Loader\DirectoryLoader;
  27. use Symfony\Component\DependencyInjection\Loader\GlobFileLoader;
  28. use Symfony\Component\DependencyInjection\Loader\IniFileLoader;
  29. use Symfony\Component\DependencyInjection\Loader\PhpFileLoader;
  30. use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
  31. use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
  32. use Symfony\Component\Filesystem\Filesystem;
  33. use Symfony\Component\HttpFoundation\Request;
  34. use Symfony\Component\HttpFoundation\Response;
  35. use Symfony\Component\HttpKernel\Bundle\BundleInterface;
  36. use Symfony\Component\HttpKernel\Config\FileLocator;
  37. use Symfony\Component\HttpKernel\DependencyInjection\AddAnnotatedClassesToCachePass;
  38. use Symfony\Component\HttpKernel\DependencyInjection\MergeExtensionConfigurationPass;
  40. /**
  41.  * The Kernel is the heart of the Symfony system.
  42.  *
  43.  * It manages an environment made of bundles.
  44.  *
  45.  * Environment names must always start with a letter and
  46.  * they must only contain letters and numbers.
  47.  *
  48.  * @author Fabien Potencier <fabien@symfony.com>
  49.  */
  50. abstract class Kernel implements KernelInterface, RebootableInterface, TerminableInterface
  51. {
  52.     /**
  53.      * @var BundleInterface[]
  54.      */
  55.     protected $bundles = [];
  57.     protected $container;
  58.     /**
  59.      * @deprecated since Symfony 4.2
  60.      */
  61.     protected $rootDir;
  62.     protected $environment;
  63.     protected $debug;
  64.     protected $booted = false;
  65.     /**
  66.      * @deprecated since Symfony 4.2
  67.      */
  68.     protected $name;
  69.     protected $startTime;
  71.     private $projectDir;
  72.     private $warmupDir;
  73.     private $requestStackSize = 0;
  74.     private $resetServices = false;
  76.     const VERSION = '4.3.2';
  77.     const VERSION_ID = 40302;
  78.     const MAJOR_VERSION = 4;
  79.     const MINOR_VERSION = 3;
  80.     const RELEASE_VERSION = 2;
  81.     const EXTRA_VERSION = '';
  83.     const END_OF_MAINTENANCE = '01/2020';
  84.     const END_OF_LIFE = '07/2020';
  86.     public function __construct(string $environment, bool $debug)
  87.     {
  88.         $this->environment = $environment;
  89.         $this->debug = $debug;
  90.         $this->rootDir = $this->getRootDir(false);
  91.         $this->name = $this->getName(false);
  92.     }
  94.     public function __clone()
  95.     {
  96.         $this->booted = false;
  97.         $this->container = null;
  98.         $this->requestStackSize = 0;
  99.         $this->resetServices = false;
  100.     }
  102.     /**
  103.      * {@inheritdoc}
  104.      */
  105.     public function boot()
  106.     {
  107.         if (true === $this->booted) {
  108.             if (!$this->requestStackSize && $this->resetServices) {
  109.                 if ($this->container->has('services_resetter')) {
  110.                     $this->container->get('services_resetter')->reset();
  111.                 }
  112.                 $this->resetServices = false;
  113.                 if ($this->debug) {
  114.                     $this->startTime = microtime(true);
  115.                 }
  116.             }
  118.             return;
  119.         }
  120.         if ($this->debug) {
  121.             $this->startTime = microtime(true);
  122.         }
  123.         if ($this->debug && !isset($_ENV['SHELL_VERBOSITY']) && !isset($_SERVER['SHELL_VERBOSITY'])) {
  124.             putenv('SHELL_VERBOSITY=3');
  125.             $_ENV['SHELL_VERBOSITY'] = 3;
  126.             $_SERVER['SHELL_VERBOSITY'] = 3;
  127.         }
  129.         // init bundles
  130.         $this->initializeBundles();
  132.         // init container
  133.         $this->initializeContainer();
  135.         foreach ($this->getBundles() as $bundle) {
  136.             $bundle->setContainer($this->container);
  137.             $bundle->boot();
  138.         }
  140.         $this->booted = true;
  141.     }
  143.     /**
  144.      * {@inheritdoc}
  145.      */
  146.     public function reboot($warmupDir)
  147.     {
  148.         $this->shutdown();
  149.         $this->warmupDir = $warmupDir;
  150.         $this->boot();
  151.     }
  153.     /**
  154.      * {@inheritdoc}
  155.      */
  156.     public function terminate(Request $request, Response $response)
  157.     {
  158.         if (false === $this->booted) {
  159.             return;
  160.         }
  162.         if ($this->getHttpKernel() instanceof TerminableInterface) {
  163.             $this->getHttpKernel()->terminate($request, $response);
  164.         }
  165.     }
  167.     /**
  168.      * {@inheritdoc}
  169.      */
  170.     public function shutdown()
  171.     {
  172.         if (false === $this->booted) {
  173.             return;
  174.         }
  176.         $this->booted = false;
  178.         foreach ($this->getBundles() as $bundle) {
  179.             $bundle->shutdown();
  180.             $bundle->setContainer(null);
  181.         }
  183.         $this->container = null;
  184.         $this->requestStackSize = 0;
  185.         $this->resetServices = false;
  186.     }
  188.     /**
  189.      * {@inheritdoc}
  190.      */
  191.     public function handle(Request $request, $type = HttpKernelInterface::MASTER_REQUEST, $catch = true)
  192.     {
  193.         $this->boot();
  194.         ++$this->requestStackSize;
  195.         $this->resetServices = true;
  197.         try {
  198.             return $this->getHttpKernel()->handle($request, $type, $catch);
  199.         } finally {
  200.             --$this->requestStackSize;
  201.         }
  202.     }
  204.     /**
  205.      * Gets a HTTP kernel from the container.
  206.      *
  207.      * @return HttpKernel
  208.      */
  209.     protected function getHttpKernel()
  210.     {
  211.         return $this->container->get('http_kernel');
  212.     }
  214.     /**
  215.      * {@inheritdoc}
  216.      */
  217.     public function getBundles()
  218.     {
  219.         return $this->bundles;
  220.     }
  222.     /**
  223.      * {@inheritdoc}
  224.      */
  225.     public function getBundle($name)
  226.     {
  227.         if (!isset($this->bundles[$name])) {
  228.             $class = \get_class($this);
  229.             $class = 'c' === $class[0] && 0 === strpos($class, "class@anonymous\0") ? get_parent_class($class).'@anonymous' : $class;
  231.             throw new \InvalidArgumentException(sprintf('Bundle "%s" does not exist or it is not enabled. Maybe you forgot to add it in the registerBundles() method of your %s.php file?', $name, $class));
  232.         }
  234.         return $this->bundles[$name];
  235.     }
  237.     /**
  238.      * {@inheritdoc}
  239.      *
  240.      * @throws \RuntimeException if a custom resource is hidden by a resource in a derived bundle
  241.      */
  242.     public function locateResource($name, $dir = null, $first = true)
  243.     {
  244.         if ('@' !== $name[0]) {
  245.             throw new \InvalidArgumentException(sprintf('A resource name must start with @ ("%s" given).', $name));
  246.         }
  248.         if (false !== strpos($name, '..')) {
  249.             throw new \RuntimeException(sprintf('File name "%s" contains invalid characters (..).', $name));
  250.         }
  252.         $bundleName = substr($name, 1);
  253.         $path = '';
  254.         if (false !== strpos($bundleName, '/')) {
  255.             list($bundleName, $path) = explode('/', $bundleName, 2);
  256.         }
  258.         $isResource = 0 === strpos($path, 'Resources') && null !== $dir;
  259.         $overridePath = substr($path, 9);
  260.         $bundle = $this->getBundle($bundleName);
  261.         $files = [];
  263.         if ($isResource && file_exists($file = $dir.'/'.$bundle->getName().$overridePath)) {
  264.             $files[] = $file;
  265.         }
  267.         if (file_exists($file = $bundle->getPath().'/'.$path)) {
  268.             if ($first && !$isResource) {
  269.                 return $file;
  270.             }
  271.             $files[] = $file;
  272.         }
  274.         if (\count($files) > 0) {
  275.             return $first && $isResource ? $files[0] : $files;
  276.         }
  278.         throw new \InvalidArgumentException(sprintf('Unable to find file "%s".', $name));
  279.     }
  281.     /**
  282.      * {@inheritdoc}
  283.      *
  284.      * @deprecated since Symfony 4.2
  285.      */
  286.     public function getName(/* $triggerDeprecation = true */)
  287.     {
  288.         if (0 === \func_num_args() || func_get_arg(0)) {
  289.             @trigger_error(sprintf('The "%s()" method is deprecated since Symfony 4.2.', __METHOD__), E_USER_DEPRECATED);
  290.         }
  292.         if (null === $this->name) {
  293.             $this->name = preg_replace('/[^a-zA-Z0-9_]+/', '', basename($this->rootDir));
  294.             if (ctype_digit($this->name[0])) {
  295.                 $this->name = '_'.$this->name;
  296.             }
  297.         }
  299.         return $this->name;
  300.     }
  302.     /**
  303.      * {@inheritdoc}
  304.      */
  305.     public function getEnvironment()
  306.     {
  307.         return $this->environment;
  308.     }
  310.     /**
  311.      * {@inheritdoc}
  312.      */
  313.     public function isDebug()
  314.     {
  315.         return $this->debug;
  316.     }
  318.     /**
  319.      * {@inheritdoc}
  320.      *
  321.      * @deprecated since Symfony 4.2, use getProjectDir() instead
  322.      */
  323.     public function getRootDir(/* $triggerDeprecation = true */)
  324.     {
  325.         if (0 === \func_num_args() || func_get_arg(0)) {
  326.             @trigger_error(sprintf('The "%s()" method is deprecated since Symfony 4.2, use getProjectDir() instead.', __METHOD__), E_USER_DEPRECATED);
  327.         }
  329.         if (null === $this->rootDir) {
  330.             $r = new \ReflectionObject($this);
  331.             $this->rootDir = \dirname($r->getFileName());
  332.         }
  334.         return $this->rootDir;
  335.     }
  337.     /**
  338.      * Gets the application root dir (path of the project's composer file).
  339.      *
  340.      * @return string The project root dir
  341.      */
  342.     public function getProjectDir()
  343.     {
  344.         if (null === $this->projectDir) {
  345.             $r = new \ReflectionObject($this);
  346.             $dir = $rootDir = \dirname($r->getFileName());
  347.             while (!file_exists($dir.'/composer.json')) {
  348.                 if ($dir === \dirname($dir)) {
  349.                     return $this->projectDir = $rootDir;
  350.                 }
  351.                 $dir = \dirname($dir);
  352.             }
  353.             $this->projectDir = $dir;
  354.         }
  356.         return $this->projectDir;
  357.     }
  359.     /**
  360.      * {@inheritdoc}
  361.      */
  362.     public function getContainer()
  363.     {
  364.         return $this->container;
  365.     }
  367.     /**
  368.      * @internal
  369.      */
  370.     public function setAnnotatedClassCache(array $annotatedClasses)
  371.     {
  372.         file_put_contents(($this->warmupDir ?: $this->getCacheDir()).'/annotations.map', sprintf('<?php return %s;', var_export($annotatedClasses, true)));
  373.     }
  375.     /**
  376.      * {@inheritdoc}
  377.      */
  378.     public function getStartTime()
  379.     {
  380.         return $this->debug ? $this->startTime : -INF;
  381.     }
  383.     /**
  384.      * {@inheritdoc}
  385.      */
  386.     public function getCacheDir()
  387.     {
  388.         return $this->getProjectDir().'/var/cache/'.$this->environment;
  389.     }
  391.     /**
  392.      * {@inheritdoc}
  393.      */
  394.     public function getLogDir()
  395.     {
  396.         return $this->getProjectDir().'/var/log';
  397.     }
  399.     /**
  400.      * {@inheritdoc}
  401.      */
  402.     public function getCharset()
  403.     {
  404.         return 'UTF-8';
  405.     }
  407.     /**
  408.      * Gets the patterns defining the classes to parse and cache for annotations.
  409.      */
  410.     public function getAnnotatedClassesToCompile(): array
  411.     {
  412.         return [];
  413.     }
  415.     /**
  416.      * Initializes bundles.
  417.      *
  418.      * @throws \LogicException if two bundles share a common name
  419.      */
  420.     protected function initializeBundles()
  421.     {
  422.         // init bundles
  423.         $this->bundles = [];
  424.         foreach ($this->registerBundles() as $bundle) {
  425.             $name = $bundle->getName();
  426.             if (isset($this->bundles[$name])) {
  427.                 throw new \LogicException(sprintf('Trying to register two bundles with the same name "%s"', $name));
  428.             }
  429.             $this->bundles[$name] = $bundle;
  430.         }
  431.     }
  433.     /**
  434.      * The extension point similar to the Bundle::build() method.
  435.      *
  436.      * Use this method to register compiler passes and manipulate the container during the building process.
  437.      */
  438.     protected function build(ContainerBuilder $container)
  439.     {
  440.     }
  442.     /**
  443.      * Gets the container class.
  444.      *
  445.      * @throws \InvalidArgumentException If the generated classname is invalid
  446.      *
  447.      * @return string The container class
  448.      */
  449.     protected function getContainerClass()
  450.     {
  451.         $class = \get_class($this);
  452.         $class = 'c' === $class[0] && 0 === strpos($class, "class@anonymous\0") ? get_parent_class($class).str_replace('.', '_', ContainerBuilder::hash($class)) : $class;
  453.         $class = $this->name.str_replace('\\', '_', $class).ucfirst($this->environment).($this->debug ? 'Debug' : '').'Container';
  455.         if (!preg_match('/^[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*$/', $class)) {
  456.             throw new \InvalidArgumentException(sprintf('The environment "%s" contains invalid characters, it can only contain characters allowed in PHP class names.', $this->environment));
  457.         }
  459.         return $class;
  460.     }
  462.     /**
  463.      * Gets the container's base class.
  464.      *
  465.      * All names except Container must be fully qualified.
  466.      *
  467.      * @return string
  468.      */
  469.     protected function getContainerBaseClass()
  470.     {
  471.         return 'Container';
  472.     }
  474.     /**
  475.      * Initializes the service container.
  476.      *
  477.      * The cached version of the service container is used when fresh, otherwise the
  478.      * container is built.
  479.      */
  480.     protected function initializeContainer()
  481.     {
  482.         $class = $this->getContainerClass();
  483.         $cacheDir = $this->warmupDir ?: $this->getCacheDir();
  484.         $cache = new ConfigCache($cacheDir.'/'.$class.'.php', $this->debug);
  485.         $oldContainer = null;
  486.         if ($fresh = $cache->isFresh()) {
  487.             // Silence E_WARNING to ignore "include" failures - don't use "@" to prevent silencing fatal errors
  488.             $errorLevel = error_reporting(\E_ALL ^ \E_WARNING);
  489.             $fresh = $oldContainer = false;
  490.             try {
  491.                 if (file_exists($cache->getPath()) && \is_object($this->container = include $cache->getPath())) {
  492.                     $this->container->set('kernel', $this);
  493.                     $oldContainer = $this->container;
  494.                     $fresh = true;
  495.                 }
  496.             } catch (\Throwable $e) {
  497.             } finally {
  498.                 error_reporting($errorLevel);
  499.             }
  500.         }
  502.         if ($fresh) {
  503.             return;
  504.         }
  506.         if ($this->debug) {
  507.             $collectedLogs = [];
  508.             $previousHandler = \defined('PHPUNIT_COMPOSER_INSTALL');
  509.             $previousHandler = $previousHandler ?: set_error_handler(function ($type, $message, $file, $line) use (&$collectedLogs, &$previousHandler) {
  510.                 if (E_USER_DEPRECATED !== $type && E_DEPRECATED !== $type) {
  511.                     return $previousHandler ? $previousHandler($type, $message, $file, $line) : false;
  512.                 }
  514.                 if (isset($collectedLogs[$message])) {
  515.                     ++$collectedLogs[$message]['count'];
  517.                     return;
  518.                 }
  520.                 $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 5);
  521.                 // Clean the trace by removing first frames added by the error handler itself.
  522.                 for ($i = 0; isset($backtrace[$i]); ++$i) {
  523.                     if (isset($backtrace[$i]['file'], $backtrace[$i]['line']) && $backtrace[$i]['line'] === $line && $backtrace[$i]['file'] === $file) {
  524.                         $backtrace = \array_slice($backtrace, 1 + $i);
  525.                         break;
  526.                     }
  527.                 }
  528.                 // Remove frames added by DebugClassLoader.
  529.                 for ($i = \count($backtrace) - 2; 0 < $i; --$i) {
  530.                     if (DebugClassLoader::class === ($backtrace[$i]['class'] ?? null)) {
  531.                         $backtrace = [$backtrace[$i + 1]];
  532.                         break;
  533.                     }
  534.                 }
  536.                 $collectedLogs[$message] = [
  537.                     'type' => $type,
  538.                     'message' => $message,
  539.                     'file' => $file,
  540.                     'line' => $line,
  541.                     'trace' => [$backtrace[0]],
  542.                     'count' => 1,
  543.                 ];
  544.             });
  545.         }
  547.         try {
  548.             $container = null;
  549.             $container = $this->buildContainer();
  550.             $container->compile();
  551.         } finally {
  552.             if ($this->debug && true !== $previousHandler) {
  553.                 restore_error_handler();
  555.                 file_put_contents($cacheDir.'/'.$class.'Deprecations.log', serialize(array_values($collectedLogs)));
  556.                 file_put_contents($cacheDir.'/'.$class.'Compiler.log', null !== $container ? implode("\n", $container->getCompiler()->getLog()) : '');
  557.             }
  558.         }
  560.         if (null === $oldContainer && file_exists($cache->getPath())) {
  561.             $errorLevel = error_reporting(\E_ALL ^ \E_WARNING);
  562.             try {
  563.                 $oldContainer = include $cache->getPath();
  564.             } catch (\Throwable $e) {
  565.             } finally {
  566.                 error_reporting($errorLevel);
  567.             }
  568.         }
  569.         $oldContainer = \is_object($oldContainer) ? new \ReflectionClass($oldContainer) : false;
  571.         $this->dumpContainer($cache, $container, $class, $this->getContainerBaseClass());
  572.         $this->container = require $cache->getPath();
  573.         $this->container->set('kernel', $this);
  575.         if ($oldContainer && \get_class($this->container) !== $oldContainer->name) {
  576.             // Because concurrent requests might still be using them,
  577.             // old container files are not removed immediately,
  578.             // but on a next dump of the container.
  579.             static $legacyContainers = [];
  580.             $oldContainerDir = \dirname($oldContainer->getFileName());
  581.             $legacyContainers[$oldContainerDir.'.legacy'] = true;
  582.             foreach (glob(\dirname($oldContainerDir).\DIRECTORY_SEPARATOR.'*.legacy') as $legacyContainer) {
  583.                 if (!isset($legacyContainers[$legacyContainer]) && @unlink($legacyContainer)) {
  584.                     (new Filesystem())->remove(substr($legacyContainer, 0, -7));
  585.                 }
  586.             }
  588.             touch($oldContainerDir.'.legacy');
  589.         }
  591.         if ($this->container->has('cache_warmer')) {
  592.             $this->container->get('cache_warmer')->warmUp($this->container->getParameter('kernel.cache_dir'));
  593.         }
  594.     }
  596.     /**
  597.      * Returns the kernel parameters.
  598.      *
  599.      * @return array An array of kernel parameters
  600.      */
  601.     protected function getKernelParameters()
  602.     {
  603.         $bundles = [];
  604.         $bundlesMetadata = [];
  606.         foreach ($this->bundles as $name => $bundle) {
  607.             $bundles[$name] = \get_class($bundle);
  608.             $bundlesMetadata[$name] = [
  609.                 'path' => $bundle->getPath(),
  610.                 'namespace' => $bundle->getNamespace(),
  611.             ];
  612.         }
  614.         return [
  615.             /*
  616.              * @deprecated since Symfony 4.2, use kernel.project_dir instead
  617.              */
  618.             'kernel.root_dir' => realpath($this->rootDir) ?: $this->rootDir,
  619.             'kernel.project_dir' => realpath($this->getProjectDir()) ?: $this->getProjectDir(),
  620.             'kernel.environment' => $this->environment,
  621.             'kernel.debug' => $this->debug,
  622.             /*
  623.              * @deprecated since Symfony 4.2
  624.              */
  625.             'kernel.name' => $this->name,
  626.             'kernel.cache_dir' => realpath($cacheDir = $this->warmupDir ?: $this->getCacheDir()) ?: $cacheDir,
  627.             'kernel.logs_dir' => realpath($this->getLogDir()) ?: $this->getLogDir(),
  628.             'kernel.bundles' => $bundles,
  629.             'kernel.bundles_metadata' => $bundlesMetadata,
  630.             'kernel.charset' => $this->getCharset(),
  631.             'kernel.container_class' => $this->getContainerClass(),
  632.         ];
  633.     }
  635.     /**
  636.      * Builds the service container.
  637.      *
  638.      * @return ContainerBuilder The compiled service container
  639.      *
  640.      * @throws \RuntimeException
  641.      */
  642.     protected function buildContainer()
  643.     {
  644.         foreach (['cache' => $this->warmupDir ?: $this->getCacheDir(), 'logs' => $this->getLogDir()] as $name => $dir) {
  645.             if (!is_dir($dir)) {
  646.                 if (false === @mkdir($dir, 0777, true) && !is_dir($dir)) {
  647.                     throw new \RuntimeException(sprintf("Unable to create the %s directory (%s)\n", $name, $dir));
  648.                 }
  649.             } elseif (!is_writable($dir)) {
  650.                 throw new \RuntimeException(sprintf("Unable to write in the %s directory (%s)\n", $name, $dir));
  651.             }
  652.         }
  654.         $container = $this->getContainerBuilder();
  655.         $container->addObjectResource($this);
  656.         $this->prepareContainer($container);
  658.         if (null !== $cont = $this->registerContainerConfiguration($this->getContainerLoader($container))) {
  659.             $container->merge($cont);
  660.         }
  662.         $container->addCompilerPass(new AddAnnotatedClassesToCachePass($this));
  664.         return $container;
  665.     }
  667.     /**
  668.      * Prepares the ContainerBuilder before it is compiled.
  669.      */
  670.     protected function prepareContainer(ContainerBuilder $container)
  671.     {
  672.         $extensions = [];
  673.         foreach ($this->bundles as $bundle) {
  674.             if ($extension = $bundle->getContainerExtension()) {
  675.                 $container->registerExtension($extension);
  676.             }
  678.             if ($this->debug) {
  679.                 $container->addObjectResource($bundle);
  680.             }
  681.         }
  683.         foreach ($this->bundles as $bundle) {
  684.             $bundle->build($container);
  685.         }
  687.         $this->build($container);
  689.         foreach ($container->getExtensions() as $extension) {
  690.             $extensions[] = $extension->getAlias();
  691.         }
  693.         // ensure these extensions are implicitly loaded
  694.         $container->getCompilerPassConfig()->setMergePass(new MergeExtensionConfigurationPass($extensions));
  695.     }
  697.     /**
  698.      * Gets a new ContainerBuilder instance used to build the service container.
  699.      *
  700.      * @return ContainerBuilder
  701.      */
  702.     protected function getContainerBuilder()
  703.     {
  704.         $container = new ContainerBuilder();
  705.         $container->getParameterBag()->add($this->getKernelParameters());
  707.         if ($this instanceof CompilerPassInterface) {
  708.             $container->addCompilerPass($this, PassConfig::TYPE_BEFORE_OPTIMIZATION, -10000);
  709.         }
  710.         if (class_exists('ProxyManager\Configuration') && class_exists('Symfony\Bridge\ProxyManager\LazyProxy\Instantiator\RuntimeInstantiator')) {
  711.             $container->setProxyInstantiator(new RuntimeInstantiator());
  712.         }
  714.         return $container;
  715.     }
  717.     /**
  718.      * Dumps the service container to PHP code in the cache.
  719.      *
  720.      * @param ConfigCache      $cache     The config cache
  721.      * @param ContainerBuilder $container The service container
  722.      * @param string           $class     The name of the class to generate
  723.      * @param string           $baseClass The name of the container's base class
  724.      */
  725.     protected function dumpContainer(ConfigCache $cache, ContainerBuilder $container, $class, $baseClass)
  726.     {
  727.         // cache the container
  728.         $dumper = new PhpDumper($container);
  730.         if (class_exists('ProxyManager\Configuration') && class_exists('Symfony\Bridge\ProxyManager\LazyProxy\PhpDumper\ProxyDumper')) {
  731.             $dumper->setProxyDumper(new ProxyDumper());
  732.         }
  734.         $content = $dumper->dump([
  735.             'class' => $class,
  736.             'base_class' => $baseClass,
  737.             'file' => $cache->getPath(),
  738.             'as_files' => true,
  739.             'debug' => $this->debug,
  740.             'build_time' => $container->hasParameter('kernel.container_build_time') ? $container->getParameter('kernel.container_build_time') : time(),
  741.         ]);
  743.         $rootCode = array_pop($content);
  744.         $dir = \dirname($cache->getPath()).'/';
  745.         $fs = new Filesystem();
  747.         foreach ($content as $file => $code) {
  748.             $fs->dumpFile($dir.$file, $code);
  749.             @chmod($dir.$file, 0666 & ~umask());
  750.         }
  751.         $legacyFile = \dirname($dir.$file).'.legacy';
  752.         if (file_exists($legacyFile)) {
  753.             @unlink($legacyFile);
  754.         }
  756.         $cache->write($rootCode, $container->getResources());
  757.     }
  759.     /**
  760.      * Returns a loader for the container.
  761.      *
  762.      * @return DelegatingLoader The loader
  763.      */
  764.     protected function getContainerLoader(ContainerInterface $container)
  765.     {
  766.         $locator = new FileLocator($this);
  767.         $resolver = new LoaderResolver([
  768.             new XmlFileLoader($container, $locator),
  769.             new YamlFileLoader($container, $locator),
  770.             new IniFileLoader($container, $locator),
  771.             new PhpFileLoader($container, $locator),
  772.             new GlobFileLoader($container, $locator),
  773.             new DirectoryLoader($container, $locator),
  774.             new ClosureLoader($container),
  775.         ]);
  777.         return new DelegatingLoader($resolver);
  778.     }
  780.     /**
  781.      * Removes comments from a PHP source string.
  782.      *
  783.      * We don't use the PHP php_strip_whitespace() function
  784.      * as we want the content to be readable and well-formatted.
  785.      *
  786.      * @param string $source A PHP string
  787.      *
  788.      * @return string The PHP string with the comments removed
  789.      */
  790.     public static function stripComments($source)
  791.     {
  792.         if (!\function_exists('token_get_all')) {
  793.             return $source;
  794.         }
  796.         $rawChunk = '';
  797.         $output = '';
  798.         $tokens = token_get_all($source);
  799.         $ignoreSpace = false;
  800.         for ($i = 0; isset($tokens[$i]); ++$i) {
  801.             $token = $tokens[$i];
  802.             if (!isset($token[1]) || 'b"' === $token) {
  803.                 $rawChunk .= $token;
  804.             } elseif (T_START_HEREDOC === $token[0]) {
  805.                 $output .= $rawChunk.$token[1];
  806.                 do {
  807.                     $token = $tokens[++$i];
  808.                     $output .= isset($token[1]) && 'b"' !== $token ? $token[1] : $token;
  809.                 } while (T_END_HEREDOC !== $token[0]);
  810.                 $rawChunk = '';
  811.             } elseif (T_WHITESPACE === $token[0]) {
  812.                 if ($ignoreSpace) {
  813.                     $ignoreSpace = false;
  815.                     continue;
  816.                 }
  818.                 // replace multiple new lines with a single newline
  819.                 $rawChunk .= preg_replace(['/\n{2,}/S'], "\n", $token[1]);
  820.             } elseif (\in_array($token[0], [T_COMMENT, T_DOC_COMMENT])) {
  821.                 $ignoreSpace = true;
  822.             } else {
  823.                 $rawChunk .= $token[1];
  825.                 // The PHP-open tag already has a new-line
  826.                 if (T_OPEN_TAG === $token[0]) {
  827.                     $ignoreSpace = true;
  828.                 }
  829.             }
  830.         }
  832.         $output .= $rawChunk;
  834.         unset($tokens, $rawChunk);
  835.         gc_mem_caches();
  837.         return $output;
  838.     }
  840.     /**
  841.      * @deprecated since Symfony 4.3
  842.      */
  843.     public function serialize()
  844.     {
  845.         @trigger_error(sprintf('The "%s" method is deprecated since Symfony 4.3.', __METHOD__), E_USER_DEPRECATED);
  847.         return serialize([$this->environment, $this->debug]);
  848.     }
  850.     /**
  851.      * @deprecated since Symfony 4.3
  852.      */
  853.     public function unserialize($data)
  854.     {
  855.         @trigger_error(sprintf('The "%s" method is deprecated since Symfony 4.3.', __METHOD__), E_USER_DEPRECATED);
  856.         list($environment, $debug) = unserialize($data, ['allowed_classes' => false]);
  858.         $this->__construct($environment, $debug);
  859.     }
  861.     public function __sleep()
  862.     {
  863.         if (__CLASS__ !== $c = (new \ReflectionMethod($this, 'serialize'))->getDeclaringClass()->name) {
  864.             @trigger_error(sprintf('Implementing the "%s::serialize()" method is deprecated since Symfony 4.3.', $c), E_USER_DEPRECATED);
  865.             $this->serialized = $this->serialize();
  867.             return ['serialized'];
  868.         }
  870.         return ['environment', 'debug'];
  871.     }
  873.     public function __wakeup()
  874.     {
  875.         if (__CLASS__ !== $c = (new \ReflectionMethod($this, 'serialize'))->getDeclaringClass()->name) {
  876.             @trigger_error(sprintf('Implementing the "%s::serialize()" method is deprecated since Symfony 4.3.', $c), E_USER_DEPRECATED);
  877.             $this->unserialize($this->serialized);
  878.             unset($this->serialized);
  880.             return;
  881.         }
  882.         $this->__construct($this->environment, $this->debug);
  883.     }
  884. }