vendor/symfony/dependency-injection/Loader/PhpFileLoader.php line 146

  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\DependencyInjection\Loader;
  14. use Symfony\Component\Config\Builder\ConfigBuilderGenerator;
  15. use Symfony\Component\Config\Builder\ConfigBuilderGeneratorInterface;
  16. use Symfony\Component\Config\Builder\ConfigBuilderInterface;
  17. use Symfony\Component\Config\FileLocatorInterface;
  18. use Symfony\Component\DependencyInjection\Attribute\When;
  19. use Symfony\Component\DependencyInjection\Container;
  20. use Symfony\Component\DependencyInjection\ContainerBuilder;
  21. use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
  22. use Symfony\Component\DependencyInjection\Extension\ConfigurationExtensionInterface;
  23. use Symfony\Component\DependencyInjection\Extension\ExtensionInterface;
  24. use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
  26. /**
  27.  * PhpFileLoader loads service definitions from a PHP file.
  28.  *
  29.  * The PHP file is required and the $container variable can be
  30.  * used within the file to change the container.
  31.  *
  32.  * @author Fabien Potencier <fabien@symfony.com>
  33.  */
  34. class PhpFileLoader extends FileLoader
  35. {
  36.     protected $autoRegisterAliasesForSinglyImplementedInterfaces = false;
  37.     private ?ConfigBuilderGeneratorInterface $generator;
  39.     public function __construct(ContainerBuilder $container, FileLocatorInterface $locator, string $env = null, ConfigBuilderGeneratorInterface $generator = null)
  40.     {
  41.         parent::__construct($container, $locator, $env);
  42.         $this->generator = $generator;
  43.     }
  45.     public function load(mixed $resource, string $type = null): mixed
  46.     {
  47.         // the container and loader variables are exposed to the included file below
  48.         $container = $this->container;
  49.         $loader = $this;
  51.         $path = $this->locator->locate($resource);
  52.         $this->setCurrentDir(\dirname($path));
  53.         $this->container->fileExists($path);
  55.         // the closure forbids access to the private scope in the included file
  56.         $load = \Closure::bind(function ($path, $env) use ($container, $loader, $resource, $type) {
  57.             return include $path;
  58.         }, $this, ProtectedPhpFileLoader::class);
  60.         try {
  61.             $callback = $load($path, $this->env);
  63.             if (\is_object($callback) && \is_callable($callback)) {
  64.                 $this->executeCallback($callback, new ContainerConfigurator($this->container, $this, $this->instanceof, $path, $resource, $this->env), $path);
  65.             }
  66.         } finally {
  67.             $this->instanceof = [];
  68.             $this->registerAliasesForSinglyImplementedInterfaces();
  69.         }
  71.         return null;
  72.     }
  74.     public function supports(mixed $resource, string $type = null): bool
  75.     {
  76.         if (!\is_string($resource)) {
  77.             return false;
  78.         }
  80.         if (null === $type && 'php' === pathinfo($resource, \PATHINFO_EXTENSION)) {
  81.             return true;
  82.         }
  84.         return 'php' === $type;
  85.     }
  87.     /**
  88.      * Resolve the parameters to the $callback and execute it.
  89.      */
  90.     private function executeCallback(callable $callback, ContainerConfigurator $containerConfigurator, string $path)
  91.     {
  92.         $callback = $callback(...);
  93.         $arguments = [];
  94.         $configBuilders = [];
  95.         $r = new \ReflectionFunction($callback);
  97.         $attribute = null;
  98.         foreach ($r->getAttributes(When::class, \ReflectionAttribute::IS_INSTANCEOF) as $attribute) {
  99.             if ($this->env === $attribute->newInstance()->env) {
  100.                 $attribute = null;
  101.                 break;
  102.             }
  103.         }
  104.         if (null !== $attribute) {
  105.             return;
  106.         }
  108.         foreach ($r->getParameters() as $parameter) {
  109.             $reflectionType = $parameter->getType();
  110.             if (!$reflectionType instanceof \ReflectionNamedType) {
  111.                 throw new \InvalidArgumentException(sprintf('Could not resolve argument "$%s" for "%s". You must typehint it (for example with "%s" or "%s").', $parameter->getName(), $path, ContainerConfigurator::class, ContainerBuilder::class));
  112.             }
  113.             $type = $reflectionType->getName();
  115.             switch ($type) {
  116.                 case ContainerConfigurator::class:
  117.                     $arguments[] = $containerConfigurator;
  118.                     break;
  119.                 case ContainerBuilder::class:
  120.                     $arguments[] = $this->container;
  121.                     break;
  122.                 case FileLoader::class:
  123.                 case self::class:
  124.                     $arguments[] = $this;
  125.                     break;
  126.                 case 'string':
  127.                     if (null !== $this->env && 'env' === $parameter->getName()) {
  128.                         $arguments[] = $this->env;
  129.                         break;
  130.                     }
  131.                     // no break
  132.                 default:
  133.                     try {
  134.                         $configBuilder = $this->configBuilder($type);
  135.                     } catch (InvalidArgumentException|\LogicException $e) {
  136.                         throw new \InvalidArgumentException(sprintf('Could not resolve argument "%s" for "%s".', $type.' $'.$parameter->getName(), $path), 0, $e);
  137.                     }
  138.                     $configBuilders[] = $configBuilder;
  139.                     $arguments[] = $configBuilder;
  140.             }
  141.         }
  143.         // Force load ContainerConfigurator to make env(), param() etc available.
  144.         class_exists(ContainerConfigurator::class);
  146.         $callback(...$arguments);
  148.         /** @var ConfigBuilderInterface $configBuilder */
  149.         foreach ($configBuilders as $configBuilder) {
  150.             $containerConfigurator->extension($configBuilder->getExtensionAlias(), $configBuilder->toArray());
  151.         }
  152.     }
  154.     /**
  155.      * @param string $namespace FQCN string for a class implementing ConfigBuilderInterface
  156.      */
  157.     private function configBuilder(string $namespace): ConfigBuilderInterface
  158.     {
  159.         if (!class_exists(ConfigBuilderGenerator::class)) {
  160.             throw new \LogicException('You cannot use the config builder as the Config component is not installed. Try running "composer require symfony/config".');
  161.         }
  163.         if (null === $this->generator) {
  164.             throw new \LogicException('You cannot use the ConfigBuilders without providing a class implementing ConfigBuilderGeneratorInterface.');
  165.         }
  167.         // If class exists and implements ConfigBuilderInterface
  168.         if (class_exists($namespace) && is_subclass_of($namespace, ConfigBuilderInterface::class)) {
  169.             return new $namespace();
  170.         }
  172.         // If it does not start with Symfony\Config\ we don't know how to handle this
  173.         if (!str_starts_with($namespace, 'Symfony\\Config\\')) {
  174.             throw new InvalidArgumentException(sprintf('Could not find or generate class "%s".', $namespace));
  175.         }
  177.         // Try to get the extension alias
  178.         $alias = Container::underscore(substr($namespace, 15, -6));
  180.         if (str_contains($alias, '\\')) {
  181.             throw new InvalidArgumentException('You can only use "root" ConfigBuilders from "Symfony\\Config\\" namespace. Nested classes like "Symfony\\Config\\Framework\\CacheConfig" cannot be used.');
  182.         }
  184.         if (!$this->container->hasExtension($alias)) {
  185.             $extensions = array_filter(array_map(function (ExtensionInterface $ext) { return $ext->getAlias(); }, $this->container->getExtensions()));
  186.             throw new InvalidArgumentException(sprintf('There is no extension able to load the configuration for "%s". Looked for namespace "%s", found "%s".', $namespace, $alias, $extensions ? implode('", "', $extensions) : 'none'));
  187.         }
  189.         $extension = $this->container->getExtension($alias);
  190.         if (!$extension instanceof ConfigurationExtensionInterface) {
  191.             throw new \LogicException(sprintf('You cannot use the config builder for "%s" because the extension does not implement "%s".', $namespace, ConfigurationExtensionInterface::class));
  192.         }
  194.         $configuration = $extension->getConfiguration([], $this->container);
  195.         $loader = $this->generator->build($configuration);
  197.         return $loader();
  198.     }
  199. }
  201. /**
  202.  * @internal
  203.  */
  204. final class ProtectedPhpFileLoader extends PhpFileLoader
  205. {
  206. }