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

  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.     public function getXsdValidationBasePath()
  32.     {
  33.         return false;
  34.     }
  36.     public function getNamespace()
  37.     {
  38.         return 'http://example.org/schema/dic/'.$this->getAlias();
  39.     }
  41.     /**
  42.      * Returns the recommended alias to use in XML.
  43.      *
  44.      * This alias is also the mandatory prefix to use when using YAML.
  45.      *
  46.      * This convention is to remove the "Extension" postfix from the class
  47.      * name and then lowercase and underscore the result. So:
  48.      *
  49.      *     AcmeHelloExtension
  50.      *
  51.      * becomes
  52.      *
  53.      *     acme_hello
  54.      *
  55.      * This can be overridden in a sub-class to specify the alias manually.
  56.      *
  57.      * @throws BadMethodCallException When the extension name does not follow conventions
  58.      */
  59.     public function getAlias(): string
  60.     {
  61.         $className = static::class;
  62.         if (!str_ends_with($className, 'Extension')) {
  63.             throw new BadMethodCallException('This extension does not follow the naming convention; you must overwrite the getAlias() method.');
  64.         }
  65.         $classBaseName = substr(strrchr($className, '\\'), 1, -9);
  67.         return Container::underscore($classBaseName);
  68.     }
  70.     public function getConfiguration(array $config, ContainerBuilder $container)
  71.     {
  72.         $class = static::class;
  74.         if (str_contains($class, "\0")) {
  75.             return null; // ignore anonymous classes
  76.         }
  78.         $class = substr_replace($class, '\Configuration', strrpos($class, '\\'));
  79.         $class = $container->getReflectionClass($class);
  81.         if (!$class) {
  82.             return null;
  83.         }
  85.         if (!$class->implementsInterface(ConfigurationInterface::class)) {
  86.             throw new LogicException(sprintf('The extension configuration class "%s" must implement "%s".', $class->getName(), ConfigurationInterface::class));
  87.         }
  89.         if (!($constructor = $class->getConstructor()) || !$constructor->getNumberOfRequiredParameters()) {
  90.             return $class->newInstance();
  91.         }
  93.         return null;
  94.     }
  96.     final protected function processConfiguration(ConfigurationInterface $configuration, array $configs): array
  97.     {
  98.         $processor = new Processor();
  100.         return $this->processedConfigs[] = $processor->processConfiguration($configuration, $configs);
  101.     }
  103.     /**
  104.      * @internal
  105.      */
  106.     final public function getProcessedConfigs(): array
  107.     {
  108.         try {
  109.             return $this->processedConfigs;
  110.         } finally {
  111.             $this->processedConfigs = [];
  112.         }
  113.     }
  115.     /**
  116.      * @throws InvalidArgumentException When the config is not enableable
  117.      */
  118.     protected function isConfigEnabled(ContainerBuilder $container, array $config): bool
  119.     {
  120.         if (!\array_key_exists('enabled', $config)) {
  121.             throw new InvalidArgumentException("The config array has no 'enabled' key.");
  122.         }
  124.         return (bool) $container->getParameterBag()->resolveValue($config['enabled']);
  125.     }
  126. }