vendor/symfony/http-kernel/Bundle/Bundle.php line 146

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\Bundle;
  14. use Symfony\Component\Console\Application;
  15. use Symfony\Component\DependencyInjection\Container;
  16. use Symfony\Component\DependencyInjection\ContainerAwareTrait;
  17. use Symfony\Component\DependencyInjection\ContainerBuilder;
  18. use Symfony\Component\DependencyInjection\Extension\ExtensionInterface;
  20. /**
  21.  * An implementation of BundleInterface that adds a few conventions for DependencyInjection extensions.
  22.  *
  23.  * @author Fabien Potencier <fabien@symfony.com>
  24.  */
  25. abstract class Bundle implements BundleInterface
  26. {
  27.     use ContainerAwareTrait;
  29.     protected $name;
  30.     protected $extension;
  31.     protected $path;
  32.     private string $namespace;
  34.     /**
  35.      * {@inheritdoc}
  36.      */
  37.     public function boot()
  38.     {
  39.     }
  41.     /**
  42.      * {@inheritdoc}
  43.      */
  44.     public function shutdown()
  45.     {
  46.     }
  48.     /**
  49.      * {@inheritdoc}
  50.      *
  51.      * This method can be overridden to register compilation passes,
  52.      * other extensions, ...
  53.      */
  54.     public function build(ContainerBuilder $container)
  55.     {
  56.     }
  58.     /**
  59.      * Returns the bundle's container extension.
  60.      *
  61.      * @throws \LogicException
  62.      */
  63.     public function getContainerExtension(): ?ExtensionInterface
  64.     {
  65.         if (null === $this->extension) {
  66.             $extension = $this->createContainerExtension();
  68.             if (null !== $extension) {
  69.                 if (!$extension instanceof ExtensionInterface) {
  70.                     throw new \LogicException(sprintf('Extension "%s" must implement Symfony\Component\DependencyInjection\Extension\ExtensionInterface.', get_debug_type($extension)));
  71.                 }
  73.                 // check naming convention
  74.                 $basename = preg_replace('/Bundle$/', '', $this->getName());
  75.                 $expectedAlias = Container::underscore($basename);
  77.                 if ($expectedAlias != $extension->getAlias()) {
  78.                     throw new \LogicException(sprintf('Users will expect the alias of the default extension of a bundle to be the underscored version of the bundle name ("%s"). You can override "Bundle::getContainerExtension()" if you want to use "%s" or another alias.', $expectedAlias, $extension->getAlias()));
  79.                 }
  81.                 $this->extension = $extension;
  82.             } else {
  83.                 $this->extension = false;
  84.             }
  85.         }
  87.         return $this->extension ?: null;
  88.     }
  90.     /**
  91.      * {@inheritdoc}
  92.      */
  93.     public function getNamespace(): string
  94.     {
  95.         if (!isset($this->namespace)) {
  96.             $this->parseClassName();
  97.         }
  99.         return $this->namespace;
  100.     }
  102.     /**
  103.      * {@inheritdoc}
  104.      */
  105.     public function getPath(): string
  106.     {
  107.         if (null === $this->path) {
  108.             $reflected = new \ReflectionObject($this);
  109.             $this->path = \dirname($reflected->getFileName());
  110.         }
  112.         return $this->path;
  113.     }
  115.     /**
  116.      * Returns the bundle name (the class short name).
  117.      */
  118.     final public function getName(): string
  119.     {
  120.         if (null === $this->name) {
  121.             $this->parseClassName();
  122.         }
  124.         return $this->name;
  125.     }
  127.     public function registerCommands(Application $application)
  128.     {
  129.     }
  131.     /**
  132.      * Returns the bundle's container extension class.
  133.      */
  134.     protected function getContainerExtensionClass(): string
  135.     {
  136.         $basename = preg_replace('/Bundle$/', '', $this->getName());
  138.         return $this->getNamespace().'\\DependencyInjection\\'.$basename.'Extension';
  139.     }
  141.     /**
  142.      * Creates the bundle's container extension.
  143.      */
  144.     protected function createContainerExtension(): ?ExtensionInterface
  145.     {
  146.         return class_exists($class = $this->getContainerExtensionClass()) ? new $class() : null;
  147.     }
  149.     private function parseClassName()
  150.     {
  151.         $pos = strrpos(static::class, '\\');
  152.         $this->namespace = false === $pos ? '' : substr(static::class, 0, $pos);
  153.         if (null === $this->name) {
  154.             $this->name = false === $pos ? static::class : substr(static::class, $pos + 1);
  155.         }
  156.     }
  157. }