vendor/sulu/sulu/src/Sulu/Component/DocumentManager/Metadata/BaseMetadataFactory.php line 189

Open in your IDE?
  1. <?php
  3. /*
  4. * This file is part of Sulu.
  5. *
  6. * (c) Sulu GmbH
  7. *
  8. * This source file is subject to the MIT license that is bundled
  9. * with this source code in the file LICENSE.
  10. */
  12. namespace Sulu\Component\DocumentManager\Metadata;
  14. use PHPCR\NodeInterface;
  15. use Sulu\Component\DocumentManager\ClassNameInflector;
  16. use Sulu\Component\DocumentManager\Event\MetadataLoadEvent;
  17. use Sulu\Component\DocumentManager\Events;
  18. use Sulu\Component\DocumentManager\Exception\MetadataNotFoundException;
  19. use Sulu\Component\DocumentManager\Metadata;
  20. use Sulu\Component\DocumentManager\MetadataFactoryInterface;
  21. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  23. /**
  24. * Simple metadata factory which uses an array map.
  25. *
  26. * Note that this class does not implement the getMetadataForPhpcrNode method
  27. * as that would require a circular dependency.
  28. */
  29. class BaseMetadataFactory implements MetadataFactoryInterface
  30. {
  31. /**
  32. * @var array
  33. */
  34. private $aliasMap = [];
  36. /**
  37. * @var array
  38. */
  39. private $classMap = [];
  41. /**
  42. * @var array
  43. */
  44. private $phpcrTypeMap = [];
  46. /**
  47. * @var Metadata[]
  48. */
  49. private $metadata = [];
  51. public function __construct(private EventDispatcherInterface $dispatcher, array $mapping)
  52. {
  53. foreach ($mapping as $map) {
  54. $this->aliasMap[$map['alias']] = $map;
  55. $this->classMap[$map['class']] = $map;
  56. $this->phpcrTypeMap[$map['phpcr_type']] = $map;
  57. }
  58. }
  60. public function getMetadataForAlias($alias)
  61. {
  62. if (!isset($this->aliasMap[$alias])) {
  63. throw new MetadataNotFoundException(\sprintf(
  64. 'Metadata with alias "%s" not found, known aliases: "%s"',
  65. $alias, \implode('", "', \array_keys($this->aliasMap))
  66. ));
  67. }
  69. $map = $this->aliasMap[$alias];
  71. return $this->loadMetadata($map);
  72. }
  74. public function getMetadataForPhpcrType($phpcrType)
  75. {
  76. if (!isset($this->phpcrTypeMap[$phpcrType])) {
  77. throw new MetadataNotFoundException(\sprintf(
  78. 'Metadata with phpcrType "%s" not found, known phpcrTypes: "%s"',
  79. $phpcrType, \implode('", "', \array_keys($this->phpcrTypeMap))
  80. ));
  81. }
  83. $map = $this->phpcrTypeMap[$phpcrType];
  85. return $this->loadMetadata($map);
  86. }
  88. public function hasMetadataForPhpcrType($phpcrType)
  89. {
  90. return isset($this->phpcrTypeMap[$phpcrType]);
  91. }
  93. public function hasMetadataForClass($class)
  94. {
  95. $class = ClassNameInflector::getUserClassName($class);
  97. return isset($this->classMap[$class]);
  98. }
  100. public function getMetadataForClass($class)
  101. {
  102. $class = ClassNameInflector::getUserClassName($class);
  104. if (!isset($this->classMap[$class])) {
  105. throw new MetadataNotFoundException(\sprintf(
  106. 'Metadata with class "%s" not found, known classes: "%s"',
  107. $class, \implode('", "', \array_keys($this->classMap))
  108. ));
  109. }
  111. $map = $this->classMap[$class];
  113. return $this->loadMetadata($map);
  114. }
  116. public function hasAlias($alias)
  117. {
  118. return isset($this->aliasMap[$alias]);
  119. }
  121. public function getAliases()
  122. {
  123. return \array_keys($this->aliasMap);
  124. }
  126. public function getMetadataForPhpcrNode(NodeInterface $node)
  127. {
  128. throw new \BadMethodCallException(
  129. 'The BaseMetadataFactory does not implement this method'
  130. );
  131. }
  133. /**
  134. * @return array
  135. */
  136. public function getPhpcrTypeMap()
  137. {
  138. return $this->phpcrTypeMap;
  139. }
  141. public function getAllMetadata()
  142. {
  143. $metadatas = [];
  144. foreach (\array_keys($this->aliasMap) as $alias) {
  145. $metadatas[] = $this->getMetadataForAlias($alias);
  146. }
  148. return $metadatas;
  149. }
  151. /**
  152. * @param array $mapping
  153. *
  154. * @return Metadata
  155. */
  156. private function loadMetadata($mapping)
  157. {
  158. $mapping = \array_merge([
  159. 'alias' => null,
  160. 'phpcr_type' => null,
  161. 'form_type' => null,
  162. 'class' => null,
  163. 'mapping' => [],
  164. 'sync_remove_live' => true,
  165. 'set_default_author' => true,
  166. ], $mapping);
  168. if (isset($this->metadata[$mapping['alias']])) {
  169. return $this->metadata[$mapping['alias']];
  170. }
  172. $metadata = new Metadata();
  173. $metadata->setAlias($mapping['alias']);
  174. $metadata->setPhpcrType($mapping['phpcr_type']);
  175. $metadata->setFormType($mapping['form_type']);
  176. $metadata->setClass($mapping['class']);
  177. $metadata->setSyncRemoveLive($mapping['sync_remove_live']);
  178. $metadata->setDefaultAuthor($mapping['set_default_author']);
  180. foreach ($mapping['mapping'] as $fieldName => $fieldMapping) {
  181. $fieldMapping = \array_merge([
  182. 'encoding' => 'content',
  183. 'property' => $fieldName,
  184. ], $fieldMapping);
  185. $metadata->addFieldMapping($fieldName, $fieldMapping);
  186. }
  188. $event = new MetadataLoadEvent($metadata);
  189. $this->dispatcher->dispatch($event, Events::METADATA_LOAD);
  191. $this->metadata[$mapping['alias']] = $metadata;
  193. return $metadata;
  194. }
  195. }