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

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 $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.      * @return string
  64.      *
  65.      * @throws BadMethodCallException When the extension name does not follow conventions
  66.      */
  67.     public function getAlias()
  68.     {
  69.         $className = static::class;
  70.         if (!str_ends_with($className, 'Extension')) {
  71.             throw new BadMethodCallException('This extension does not follow the naming convention; you must overwrite the getAlias() method.');
  72.         }
  73.         $classBaseName = substr(strrchr($className, '\\'), 1, -9);
  75.         return Container::underscore($classBaseName);
  76.     }
  78.     /**
  79.      * {@inheritdoc}
  80.      */
  81.     public function getConfiguration(array $config, ContainerBuilder $container)
  82.     {
  83.         $class = static::class;
  85.         if (str_contains($class, "\0")) {
  86.             return null; // ignore anonymous classes
  87.         }
  89.         $class = substr_replace($class, '\Configuration', strrpos($class, '\\'));
  90.         $class = $container->getReflectionClass($class);
  92.         if (!$class) {
  93.             return null;
  94.         }
  96.         if (!$class->implementsInterface(ConfigurationInterface::class)) {
  97.             throw new LogicException(sprintf('The extension configuration class "%s" must implement "%s".', $class->getName(), ConfigurationInterface::class));
  98.         }
  100.         if (!($constructor = $class->getConstructor()) || !$constructor->getNumberOfRequiredParameters()) {
  101.             return $class->newInstance();
  102.         }
  104.         return null;
  105.     }
  107.     final protected function processConfiguration(ConfigurationInterface $configuration, array $configs): array
  108.     {
  109.         $processor = new Processor();
  111.         return $this->processedConfigs[] = $processor->processConfiguration($configuration, $configs);
  112.     }
  114.     /**
  115.      * @internal
  116.      */
  117.     final public function getProcessedConfigs(): array
  118.     {
  119.         try {
  120.             return $this->processedConfigs;
  121.         } finally {
  122.             $this->processedConfigs = [];
  123.         }
  124.     }
  126.     /**
  127.      * @return bool
  128.      *
  129.      * @throws InvalidArgumentException When the config is not enableable
  130.      */
  131.     protected function isConfigEnabled(ContainerBuilder $container, array $config)
  132.     {
  133.         if (!\array_key_exists('enabled', $config)) {
  134.             throw new InvalidArgumentException("The config array has no 'enabled' key.");
  135.         }
  137.         return (bool) $container->getParameterBag()->resolveValue($config['enabled']);
  138.     }
  139. }