vendor/sylius/resource-bundle/src/Bundle/AbstractResourceBundle.php line 115

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Sylius package.
  5.  *
  6.  * (c) Paweł Jędrzejewski
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. declare(strict_types=1);
  14. namespace Sylius\Bundle\ResourceBundle;
  16. use Doctrine\Bundle\DoctrineBundle\DependencyInjection\Compiler\DoctrineOrmMappingsPass;
  17. use Doctrine\Bundle\MongoDBBundle\DependencyInjection\Compiler\DoctrineMongoDBMappingsPass;
  18. use Doctrine\Bundle\PHPCRBundle\DependencyInjection\Compiler\DoctrinePhpcrMappingsPass;
  19. use Sylius\Bundle\ResourceBundle\DependencyInjection\Driver\Exception\UnknownDriverException;
  20. use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
  21. use Symfony\Component\DependencyInjection\Container;
  22. use Symfony\Component\DependencyInjection\ContainerBuilder;
  23. use Symfony\Component\HttpKernel\Bundle\Bundle;
  25. abstract class AbstractResourceBundle extends Bundle implements ResourceBundleInterface
  26. {
  27.     /**
  28.      * Configure format of mapping files.
  29.      *
  30.      * @var string
  31.      */
  32.     protected $mappingFormat = ResourceBundleInterface::MAPPING_XML;
  34.     /**
  35.      * {@inheritdoc}
  36.      */
  37.     public function build(ContainerBuilder $container): void
  38.     {
  39.         if (null !== $this->getModelNamespace()) {
  40.             foreach ($this->getSupportedDrivers() as $driver) {
  41.                 [$compilerPassClassName, $compilerPassMethod] = $this->getMappingCompilerPassInfo($driver);
  43.                 if (class_exists($compilerPassClassName)) {
  44.                     if (!method_exists($compilerPassClassName, $compilerPassMethod)) {
  45.                         throw new InvalidConfigurationException(
  46.                             "The 'mappingFormat' value is invalid, must be 'xml', 'yml' or 'annotation'."
  47.                         );
  48.                     }
  50.                     switch ($this->mappingFormat) {
  51.                         case ResourceBundleInterface::MAPPING_XML:
  52.                         case ResourceBundleInterface::MAPPING_YAML:
  53.                             $container->addCompilerPass($compilerPassClassName::$compilerPassMethod(
  54.                                 [$this->getConfigFilesPath() => $this->getModelNamespace()],
  55.                                 [$this->getObjectManagerParameter()],
  56.                                 sprintf('%s.driver.%s', $this->getBundlePrefix(), $driver)
  57.                             ));
  59.                             break;
  60.                         case ResourceBundleInterface::MAPPING_ANNOTATION:
  61.                             $container->addCompilerPass($compilerPassClassName::$compilerPassMethod(
  62.                                 [$this->getModelNamespace()],
  63.                                 [$this->getConfigFilesPath()],
  64.                                 [sprintf('%s.object_manager', $this->getBundlePrefix())],
  65.                                 sprintf('%s.driver.%s', $this->getBundlePrefix(), $driver)
  66.                             ));
  68.                             break;
  69.                     }
  70.                 }
  71.             }
  72.         }
  73.     }
  75.     /**
  76.      * Return the prefix of the bundle.
  77.      */
  78.     protected function getBundlePrefix(): string
  79.     {
  80.         return Container::underscore(substr((string) strrchr(get_class($this), '\\'), 1, -6));
  81.     }
  83.     /**
  84.      * Return the directory where are stored the doctrine mapping.
  85.      */
  86.     protected function getDoctrineMappingDirectory(): string
  87.     {
  88.         return 'model';
  89.     }
  91.     /**
  92.      * Return the entity namespace.
  93.      *
  94.      * @return string
  95.      */
  96.     protected function getModelNamespace(): ?string
  97.     {
  98.         return (new \ReflectionClass($this))->getNamespaceName() . '\\Model';
  99.     }
  101.     /**
  102.      * Return mapping compiler pass class depending on driver.
  103.      *
  104.      *
  105.      *
  106.      * @throws UnknownDriverException
  107.      */
  108.     protected function getMappingCompilerPassInfo(string $driverType): array
  109.     {
  110.         switch ($driverType) {
  111.             case SyliusResourceBundle::DRIVER_DOCTRINE_MONGODB_ODM:
  112.                 @trigger_error(sprintf(
  113.                     'The "%s" driver is deprecated in Sylius 1.3. Doctrine MongoDB and PHPCR will no longer be supported in Sylius 2.0.',
  114.                     $driverType
  115.                 ), \E_USER_DEPRECATED);
  117.                 $mappingsPassClassname = DoctrineMongoDBMappingsPass::class;
  119.                 break;
  120.             case SyliusResourceBundle::DRIVER_DOCTRINE_ORM:
  121.                 $mappingsPassClassname = DoctrineOrmMappingsPass::class;
  123.                 break;
  124.             case SyliusResourceBundle::DRIVER_DOCTRINE_PHPCR_ODM:
  125.                 @trigger_error(sprintf(
  126.                     'The "%s" driver is deprecated in Sylius 1.3. Doctrine MongoDB and PHPCR will no longer be supported in Sylius 2.0.',
  127.                     $driverType
  128.                 ), \E_USER_DEPRECATED);
  130.                 $mappingsPassClassname = DoctrinePhpcrMappingsPass::class;
  132.                 break;
  133.             default:
  134.                 throw new UnknownDriverException($driverType);
  135.         }
  137.         $compilerPassMethod = sprintf('create%sMappingDriver', ucfirst($this->mappingFormat));
  139.         return [$mappingsPassClassname, $compilerPassMethod];
  140.     }
  142.     /**
  143.      * Return the absolute path where are stored the doctrine mapping.
  144.      */
  145.     protected function getConfigFilesPath(): string
  146.     {
  147.         return sprintf(
  148.             '%s/Resources/config/doctrine/%s',
  149.             $this->getPath(),
  150.             strtolower($this->getDoctrineMappingDirectory())
  151.         );
  152.     }
  154.     protected function getObjectManagerParameter(): string
  155.     {
  156.         return sprintf('%s.object_manager', $this->getBundlePrefix());
  157.     }
  158. }