vendor/symfony/dependency-injection/Extension/Extension.php line 105

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\DependencyInjection\Extension;
  14. use Symfony\Component\Config\Definition\ConfigurationInterface;
  15. use Symfony\Component\Config\Definition\Processor;
  16. use Symfony\Component\DependencyInjection\Container;
  17. use Symfony\Component\DependencyInjection\ContainerBuilder;
  18. use Symfony\Component\DependencyInjection\Exception\BadMethodCallException;
  19. use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
  20. use Symfony\Component\DependencyInjection\Exception\LogicException;
  22. /**
  23.  * Provides useful features shared by many extensions.
  24.  *
  25.  * @author Fabien Potencier <fabien@symfony.com>
  26.  */
  27. abstract class Extension implements ExtensionInterface, ConfigurationExtensionInterface
  28. {
  29.     private array $processedConfigs = [];
  31.     /**
  32.      * {@inheritdoc}
  33.      */
  34.     public function getXsdValidationBasePath()
  35.     {
  36.         return false;
  37.     }
  39.     /**
  40.      * {@inheritdoc}
  41.      */
  42.     public function getNamespace()
  43.     {
  44.         return 'http://example.org/schema/dic/'.$this->getAlias();
  45.     }
  47.     /**
  48.      * Returns the recommended alias to use in XML.
  49.      *
  50.      * This alias is also the mandatory prefix to use when using YAML.
  51.      *
  52.      * This convention is to remove the "Extension" postfix from the class
  53.      * name and then lowercase and underscore the result. So:
  54.      *
  55.      *     AcmeHelloExtension
  56.      *
  57.      * becomes
  58.      *
  59.      *     acme_hello
  60.      *
  61.      * This can be overridden in a sub-class to specify the alias manually.
  62.      *
  63.      * @throws BadMethodCallException When the extension name does not follow conventions
  64.      */
  65.     public function getAlias(): string
  66.     {
  67.         $className = static::class;
  68.         if (!str_ends_with($className, 'Extension')) {
  69.             throw new BadMethodCallException('This extension does not follow the naming convention; you must overwrite the getAlias() method.');
  70.         }
  71.         $classBaseName = substr(strrchr($className, '\\'), 1, -9);
  73.         return Container::underscore($classBaseName);
  74.     }
  76.     /**
  77.      * {@inheritdoc}
  78.      */
  79.     public function getConfiguration(array $config, ContainerBuilder $container)
  80.     {
  81.         $class = static::class;
  83.         if (str_contains($class, "\0")) {
  84.             return null; // ignore anonymous classes
  85.         }
  87.         $class = substr_replace($class, '\Configuration', strrpos($class, '\\'));
  88.         $class = $container->getReflectionClass($class);
  90.         if (!$class) {
  91.             return null;
  92.         }
  94.         if (!$class->implementsInterface(ConfigurationInterface::class)) {
  95.             throw new LogicException(sprintf('The extension configuration class "%s" must implement "%s".', $class->getName(), ConfigurationInterface::class));
  96.         }
  98.         if (!($constructor = $class->getConstructor()) || !$constructor->getNumberOfRequiredParameters()) {
  99.             return $class->newInstance();
  100.         }
  102.         return null;
  103.     }
  105.     final protected function processConfiguration(ConfigurationInterface $configuration, array $configs): array
  106.     {
  107.         $processor = new Processor();
  109.         return $this->processedConfigs[] = $processor->processConfiguration($configuration, $configs);
  110.     }
  112.     /**
  113.      * @internal
  114.      */
  115.     final public function getProcessedConfigs(): array
  116.     {
  117.         try {
  118.             return $this->processedConfigs;
  119.         } finally {
  120.             $this->processedConfigs = [];
  121.         }
  122.     }
  124.     /**
  125.      * @throws InvalidArgumentException When the config is not enableable
  126.      */
  127.     protected function isConfigEnabled(ContainerBuilder $container, array $config): bool
  128.     {
  129.         if (!\array_key_exists('enabled', $config)) {
  130.             throw new InvalidArgumentException("The config array has no 'enabled' key.");
  131.         }
  133.         return (bool) $container->getParameterBag()->resolveValue($config['enabled']);
  134.     }
  135. }