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

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. protected string $mappingFormat = ResourceBundleInterface::MAPPING_XML;
  32. public function build(ContainerBuilder $container): void
  33. {
  34. if (null !== $this->getModelNamespace()) {
  35. foreach ($this->getSupportedDrivers() as $driver) {
  36. [$compilerPassClassName, $compilerPassMethod] = $this->getMappingCompilerPassInfo($driver);
  38. if (class_exists($compilerPassClassName)) {
  39. if (!method_exists($compilerPassClassName, $compilerPassMethod)) {
  40. throw new InvalidConfigurationException(
  41. "The 'mappingFormat' value is invalid, must be 'xml', 'yaml' or 'annotation'.",
  42. );
  43. }
  45. switch ($this->mappingFormat) {
  46. case ResourceBundleInterface::MAPPING_XML:
  47. case ResourceBundleInterface::MAPPING_YAML:
  48. $container->addCompilerPass($compilerPassClassName::$compilerPassMethod(
  49. [$this->getConfigFilesPath() => $this->getModelNamespace()],
  50. [$this->getObjectManagerParameter()],
  51. sprintf('%s.driver.%s', $this->getBundlePrefix(), $driver),
  52. ));
  54. break;
  55. case ResourceBundleInterface::MAPPING_ANNOTATION:
  56. $container->addCompilerPass($compilerPassClassName::$compilerPassMethod(
  57. [$this->getModelNamespace()],
  58. [$this->getConfigFilesPath()],
  59. [sprintf('%s.object_manager', $this->getBundlePrefix())],
  60. sprintf('%s.driver.%s', $this->getBundlePrefix(), $driver),
  61. ));
  63. break;
  64. }
  65. }
  66. }
  67. }
  68. }
  70. /**
  71. * Return the prefix of the bundle.
  72. */
  73. protected function getBundlePrefix(): string
  74. {
  75. return Container::underscore(substr((string) strrchr(static::class, '\\'), 1, -6));
  76. }
  78. /**
  79. * Return the directory where are stored the doctrine mapping.
  80. */
  81. protected function getDoctrineMappingDirectory(): string
  82. {
  83. return 'model';
  84. }
  86. /**
  87. * Return the entity namespace.
  88. *
  89. * @return string
  90. */
  91. protected function getModelNamespace(): ?string
  92. {
  93. return (new \ReflectionClass($this))->getNamespaceName() . '\\Model';
  94. }
  96. /**
  97. * Return mapping compiler pass class depending on driver.
  98. *
  99. *
  100. *
  101. * @throws UnknownDriverException
  102. */
  103. protected function getMappingCompilerPassInfo(string $driverType): array
  104. {
  105. switch ($driverType) {
  106. case SyliusResourceBundle::DRIVER_DOCTRINE_MONGODB_ODM:
  107. trigger_deprecation(
  108. 'sylius/resource-bundle',
  109. '1.3',
  110. 'The "%s" driver is deprecated. Doctrine MongoDB and PHPCR will no longer be supported in 2.0.',
  111. SyliusResourceBundle::DRIVER_DOCTRINE_MONGODB_ODM,
  112. );
  114. $mappingsPassClassname = DoctrineMongoDBMappingsPass::class;
  116. break;
  117. case SyliusResourceBundle::DRIVER_DOCTRINE_ORM:
  118. $mappingsPassClassname = DoctrineOrmMappingsPass::class;
  120. break;
  121. case SyliusResourceBundle::DRIVER_DOCTRINE_PHPCR_ODM:
  122. trigger_deprecation(
  123. 'sylius/resource-bundle',
  124. '1.3',
  125. 'The "%s" driver is deprecated. Doctrine MongoDB and PHPCR will no longer be supported in 2.0.',
  126. SyliusResourceBundle::DRIVER_DOCTRINE_PHPCR_ODM,
  127. );
  129. $mappingsPassClassname = DoctrinePhpcrMappingsPass::class;
  131. break;
  132. default:
  133. throw new UnknownDriverException($driverType);
  134. }
  136. $compilerPassMethod = sprintf('create%sMappingDriver', ucfirst($this->mappingFormat));
  138. return [$mappingsPassClassname, $compilerPassMethod];
  139. }
  141. /**
  142. * Return the absolute path where are stored the doctrine mapping.
  143. */
  144. protected function getConfigFilesPath(): string
  145. {
  146. return sprintf(
  147. '%s/Resources/config/doctrine/%s',
  148. $this->getPath(),
  149. strtolower($this->getDoctrineMappingDirectory()),
  150. );
  151. }
  153. protected function getObjectManagerParameter(): string
  154. {
  155. return sprintf('%s.object_manager', $this->getBundlePrefix());
  156. }
  157. }