vendor/sulu/sulu/src/Sulu/Bundle/MediaBundle/Search/Subscriber/StructureMediaSearchSubscriber.php line 53

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\Bundle\MediaBundle\Search\Subscriber;
  14. use Massive\Bundle\SearchBundle\Search\Event\PreIndexEvent;
  15. use Massive\Bundle\SearchBundle\Search\SearchEvents;
  16. use Sulu\Bundle\MediaBundle\Content\MediaSelectionContainer;
  17. use Sulu\Bundle\MediaBundle\Media\Manager\MediaManagerInterface;
  18. use Sulu\Component\Content\Document\Behavior\StructureBehavior;
  19. use Sulu\Component\Webspace\Analyzer\RequestAnalyzerInterface;
  20. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  22. /**
  23. * This subscriber populates the image URL field
  24. * when a Structure containing an image field is indexed.
  25. */
  26. class StructureMediaSearchSubscriber implements EventSubscriberInterface
  27. {
  28. /**
  29. * @param string $searchImageFormat the format of the image which will be returned in the search
  30. */
  31. public function __construct(
  32. protected MediaManagerInterface $mediaManager,
  33. protected ?RequestAnalyzerInterface $requestAnalyzer,
  34. protected $searchImageFormat
  35. ) {
  36. }
  38. /**
  39. * Returns the events this subscriber has subscribed.
  40. *
  41. * @return array
  42. */
  43. public static function getSubscribedEvents()
  44. {
  45. return [
  46. SearchEvents::PRE_INDEX => 'handlePreIndex',
  47. ];
  48. }
  50. /**
  51. * Adds the image to the search document.
  52. */
  53. public function handlePreIndex(PreIndexEvent $e)
  54. {
  55. $metadata = $e->getMetadata();
  56. $document = $e->getDocument();
  57. $subject = $e->getSubject();
  58. $evaluator = $e->getFieldEvaluator();
  60. if (
  61. !$e->getSubject() instanceof StructureBehavior
  62. && StructureBehavior::class !== $metadata->getName()
  63. ) {
  64. return;
  65. }
  67. if (!$imageUrlField = $metadata->getImageUrlField()) {
  68. return;
  69. }
  71. $data = $evaluator->getValue($subject, $imageUrlField);
  72. $locale = $subject->getLocale();
  74. if (!$data) {
  75. $document->setImageUrl(null);
  77. return;
  78. }
  80. $imageUrl = $this->getImageUrl($data, $locale);
  81. $document->setImageUrl($imageUrl);
  82. }
  84. /**
  85. * Returns the url for the image.
  86. *
  87. * @param array|MediaSelectionContainer $data
  88. * @param string $locale
  89. *
  90. * @return string|null
  91. *
  92. * @throws \RuntimeException
  93. * @throws \InvalidArgumentException
  94. */
  95. private function getImageUrl($data, $locale)
  96. {
  97. // new structures will container an instance of MediaSelectionContainer
  98. if ($data instanceof MediaSelectionContainer) {
  99. $medias = $data->getData();
  100. } else {
  101. $ids = [];
  103. if (isset($data['ids'])) {
  104. $ids = \array_merge($ids, $data['ids']);
  105. } elseif (isset($data['id'])) {
  106. $ids = \array_merge($ids, [$data['id']]);
  107. }
  109. if (0 === \count($ids)) {
  110. return null;
  111. }
  113. $medias = $this->mediaManager->get($locale, [
  114. 'ids' => $ids,
  115. ]);
  116. }
  118. // no media, no thumbnail URL
  119. if (!$medias) {
  120. return null;
  121. }
  123. $media = \current($medias);
  125. if (!$media) {
  126. return null;
  127. }
  129. $formats = $media->getThumbnails();
  131. if (empty($formats)) {
  132. return null;
  133. }
  135. if (!isset($formats[$this->searchImageFormat])) {
  136. throw new \InvalidArgumentException(
  137. \sprintf('Search image format "%s" is not known', $this->searchImageFormat)
  138. );
  139. }
  141. return $formats[$this->searchImageFormat];
  142. }
  143. }