vendor/friendsofsymfony/elastica-bundle/src/Transformer/ModelToElasticaAutoTransformer.php line 61

  1. <?php
  3. /*
  4. * This file is part of the FOSElasticaBundle package.
  5. *
  6. * (c) FriendsOfSymfony <https://friendsofsymfony.github.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 FOS\ElasticaBundle\Transformer;
  14. use Elastica\Document;
  15. use FOS\ElasticaBundle\Event\PostTransformEvent;
  16. use FOS\ElasticaBundle\Event\PreTransformEvent;
  17. use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
  18. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  20. /**
  21. * Maps Elastica documents with Doctrine objects
  22. * This mapper assumes an exact match between
  23. * elastica documents ids and doctrine object ids.
  24. *
  25. * @phpstan-import-type TFields from ModelToElasticaTransformerInterface
  26. *
  27. * @phpstan-type TOptions = array{identifier: string, index: string}
  28. */
  29. class ModelToElasticaAutoTransformer implements ModelToElasticaTransformerInterface
  30. {
  31. /**
  32. * @var ?EventDispatcherInterface
  33. */
  34. protected $dispatcher;
  36. /**
  37. * Optional parameters.
  38. *
  39. * @var array
  40. *
  41. * @phpstan-var TOptions
  42. */
  43. protected $options = [
  44. 'identifier' => 'id',
  45. 'index' => '',
  46. ];
  48. /**
  49. * PropertyAccessor instance.
  50. *
  51. * @var PropertyAccessorInterface
  52. */
  53. protected $propertyAccessor;
  55. /**
  56. * Instanciates a new Mapper.
  57. *
  58. * @phpstan-param array<string, mixed> $options
  59. */
  60. public function __construct(array $options = [], ?EventDispatcherInterface $dispatcher = null)
  61. {
  62. $this->options = \array_merge($this->options, $options);
  63. $this->dispatcher = $dispatcher;
  64. }
  66. /**
  67. * Set the PropertyAccessor.
  68. */
  69. public function setPropertyAccessor(PropertyAccessorInterface $propertyAccessor): void
  70. {
  71. $this->propertyAccessor = $propertyAccessor;
  72. }
  74. /**
  75. * Transforms an object into an elastica object having the required keys.
  76. */
  77. public function transform(object $object, array $fields): Document
  78. {
  79. $identifier = $this->propertyAccessor->getValue($object, $this->options['identifier']);
  81. return $this->transformObjectToDocument($object, $fields, (string) $identifier);
  82. }
  84. /**
  85. * transform a nested document or an object property into an array of ElasticaDocument.
  86. *
  87. * @param array<object>|\Traversable<object>|\ArrayAccess<mixed,mixed>|null $objects the object to convert
  88. * @param array $fields the keys we want to have in the returned array
  89. *
  90. * @phpstan-param TFields $fields
  91. *
  92. * @return array<mixed>
  93. */
  94. protected function transformNested($objects, array $fields): ?array
  95. {
  96. if (\is_iterable($objects)) {
  97. $documents = [];
  98. foreach ($objects as $object) {
  99. $document = $this->transformObjectToDocument($object, $fields);
  100. $documents[] = $document->getData();
  101. }
  103. return $documents;
  104. }
  106. if (null !== $objects) {
  107. $document = $this->transformObjectToDocument($objects, $fields);
  109. return $document->getData();
  110. }
  112. return null;
  113. }
  115. /**
  116. * Attempts to convert any type to a string or an array of strings.
  117. *
  118. * @param mixed $value
  119. *
  120. * @return string|list<string>
  121. */
  122. protected function normalizeValue($value)
  123. {
  124. $normalizeValue = static function (&$v) {
  125. if ($v instanceof \DateTimeInterface) {
  126. $v = $v->format('c');
  127. } elseif ($v instanceof \DateInterval) {
  128. $v = $v->format('P%yY%mM%dDT%hH%iM%sS');
  129. } elseif (\PHP_VERSION_ID >= 80100 && $v instanceof \BackedEnum) {
  130. $v = $v->value;
  131. } elseif (!\is_scalar($v) && null !== $v) {
  132. $v = (string) $v;
  133. }
  134. };
  136. if (\is_iterable($value)) {
  137. $value = \is_array($value) ? $value : \iterator_to_array($value, false);
  138. \array_walk_recursive($value, $normalizeValue);
  139. } else {
  140. $normalizeValue($value);
  141. }
  143. return $value;
  144. }
  146. /**
  147. * Transforms the given object to an elastica document.
  148. *
  149. * @phpstan-param TFields $fields
  150. */
  151. protected function transformObjectToDocument(object $object, array $fields, string $identifier = ''): Document
  152. {
  153. $document = new Document($identifier, [], $this->options['index']);
  155. if ($this->dispatcher) {
  156. $this->dispatcher->dispatch($event = new PreTransformEvent($document, $fields, $object));
  158. $document = $event->getDocument();
  159. }
  161. foreach ($fields as $key => $mapping) {
  162. $path = $mapping['property_path'] ?? $key;
  163. if (false === $path) {
  164. continue;
  165. }
  166. $value = $this->propertyAccessor->getValue($object, $path);
  168. if (isset($mapping['properties'], $mapping['type'])
  169. && $mapping['properties']
  170. && \in_array($mapping['type'], ['nested', 'object'], true)
  171. ) {
  172. /* $value is a nested document or object. Transform $value into
  173. * an array of documents, respective the mapped properties.
  174. */
  175. $document->set($key, $this->transformNested($value, $mapping['properties']));
  177. continue;
  178. }
  180. if ('attachment' === ($mapping['type'] ?? null)) {
  181. // $value is an attachment. Add it to the document.
  182. if ($value instanceof \SplFileInfo) {
  183. $document->addFile($key, $value->getPathName());
  184. } else {
  185. $document->addFileContent($key, $value);
  186. }
  188. continue;
  189. }
  191. $document->set($key, $this->normalizeValue($value));
  192. }
  194. if ($this->dispatcher) {
  195. $this->dispatcher->dispatch($event = new PostTransformEvent($document, $fields, $object));
  197. $document = $event->getDocument();
  198. }
  200. return $document;
  201. }
  202. }