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

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 $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.      * @return ExtensionInterface|null
  62.      *
  63.      * @throws \LogicException
  64.      */
  65.     public function getContainerExtension()
  66.     {
  67.         if (null === $this->extension) {
  68.             $extension = $this->createContainerExtension();
  70.             if (null !== $extension) {
  71.                 if (!$extension instanceof ExtensionInterface) {
  72.                     throw new \LogicException(sprintf('Extension "%s" must implement Symfony\Component\DependencyInjection\Extension\ExtensionInterface.', get_debug_type($extension)));
  73.                 }
  75.                 // check naming convention
  76.                 $basename = preg_replace('/Bundle$/', '', $this->getName());
  77.                 $expectedAlias = Container::underscore($basename);
  79.                 if ($expectedAlias != $extension->getAlias()) {
  80.                     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()));
  81.                 }
  83.                 $this->extension = $extension;
  84.             } else {
  85.                 $this->extension = false;
  86.             }
  87.         }
  89.         return $this->extension ?: null;
  90.     }
  92.     /**
  93.      * {@inheritdoc}
  94.      */
  95.     public function getNamespace()
  96.     {
  97.         if (null === $this->namespace) {
  98.             $this->parseClassName();
  99.         }
  101.         return $this->namespace;
  102.     }
  104.     /**
  105.      * {@inheritdoc}
  106.      */
  107.     public function getPath()
  108.     {
  109.         if (null === $this->path) {
  110.             $reflected = new \ReflectionObject($this);
  111.             $this->path = \dirname($reflected->getFileName());
  112.         }
  114.         return $this->path;
  115.     }
  117.     /**
  118.      * Returns the bundle name (the class short name).
  119.      */
  120.     final public function getName(): string
  121.     {
  122.         if (null === $this->name) {
  123.             $this->parseClassName();
  124.         }
  126.         return $this->name;
  127.     }
  129.     public function registerCommands(Application $application)
  130.     {
  131.     }
  133.     /**
  134.      * Returns the bundle's container extension class.
  135.      *
  136.      * @return string
  137.      */
  138.     protected function getContainerExtensionClass()
  139.     {
  140.         $basename = preg_replace('/Bundle$/', '', $this->getName());
  142.         return $this->getNamespace().'\\DependencyInjection\\'.$basename.'Extension';
  143.     }
  145.     /**
  146.      * Creates the bundle's container extension.
  147.      *
  148.      * @return ExtensionInterface|null
  149.      */
  150.     protected function createContainerExtension()
  151.     {
  152.         return class_exists($class = $this->getContainerExtensionClass()) ? new $class() : null;
  153.     }
  155.     private function parseClassName()
  156.     {
  157.         $pos = strrpos(static::class, '\\');
  158.         $this->namespace = false === $pos ? '' : substr(static::class, 0, $pos);
  159.         if (null === $this->name) {
  160.             $this->name = false === $pos ? static::class : substr(static::class, $pos + 1);
  161.         }
  162.     }
  163. }