vendor/sulu/sulu/src/Sulu/Bundle/MediaBundle/Search/Subscriber/MediaSearchSubscriber.php line 63

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\Factory;
  16. use Massive\Bundle\SearchBundle\Search\SearchEvents;
  17. use Psr\Log\LoggerInterface;
  18. use Psr\Log\NullLogger;
  19. use Sulu\Bundle\MediaBundle\Api\Media;
  20. use Sulu\Bundle\MediaBundle\Entity\FileVersionMeta;
  21. use Sulu\Bundle\MediaBundle\Media\Manager\MediaManagerInterface;
  22. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  24. /**
  25. * This subscriber populates the image URL field
  26. * when a Structure containing an image field is indexed.
  27. */
  28. class MediaSearchSubscriber implements EventSubscriberInterface
  29. {
  30. /**
  31. * @var LoggerInterface
  32. */
  33. protected $logger;
  35. /**
  36. * @param Factory $factory Massive search factory
  37. * @param array $thumbnailMimeTypes
  38. * @param string $searchImageFormat
  39. */
  40. public function __construct(
  41. protected MediaManagerInterface $mediaManager,
  42. protected Factory $factory,
  43. protected $thumbnailMimeTypes,
  44. /**
  45. * The format of the image, which will be returned in the search.
  46. */
  47. protected $searchImageFormat,
  48. ?LoggerInterface $logger = null
  49. ) {
  50. $this->logger = $logger ?: new NullLogger();
  51. }
  53. public static function getSubscribedEvents()
  54. {
  55. return [
  56. SearchEvents::PRE_INDEX => 'handlePreIndex',
  57. ];
  58. }
  60. /**
  61. * Adds the image to the search document.
  62. */
  63. public function handlePreIndex(PreIndexEvent $event)
  64. {
  65. $metadata = $event->getMetadata();
  67. if (
  68. !$event->getSubject() instanceof FileVersionMeta
  69. && FileVersionMeta::class !== $metadata->getName()
  70. ) {
  71. return;
  72. }
  74. $document = $event->getDocument();
  75. $subject = $event->getSubject();
  76. $locale = $subject->getLocale();
  78. $fileVersion = $subject->getFileVersion();
  79. $file = $fileVersion->getFile();
  80. $media = $file->getMedia();
  82. // Do not try and get the image URL if the mime type is not in the
  83. // list of mime types for which thumbnails are generated.
  84. foreach ($this->thumbnailMimeTypes as $type) {
  85. if (\fnmatch($type, $fileVersion->getMimeType())) {
  86. $document->setImageUrl($this->getImageUrl($media, $locale));
  87. break;
  88. }
  89. }
  91. $document->addField($this->factory->createField(
  92. 'media_id',
  93. $media->getId()
  94. ));
  96. $document->addField($this->factory->createField(
  97. 'media_mime',
  98. $fileVersion->getMimeType()
  99. ));
  101. if ($collection = $media->getCollection()) {
  102. $document->addField($this->factory->createField(
  103. 'collection_id',
  104. $collection->getId()
  105. ));
  106. }
  107. }
  109. /**
  110. * Return the image URL for the given media.
  111. *
  112. * TODO: The media API needs to be improved here.
  113. */
  114. private function getImageUrl($media, $locale)
  115. {
  116. $mediaApi = new Media($media, $locale);
  117. $this->mediaManager->addFormatsAndUrl($mediaApi);
  118. $formats = $mediaApi->getThumbnails();
  120. if (!isset($formats[$this->searchImageFormat])) {
  121. $this->logger->warning(\sprintf(
  122. 'Media with ID "%s" does not have thumbnail format "%s". This thumbnail would be used by the search results.',
  123. $media->getId(),
  124. $this->searchImageFormat
  125. ));
  127. return;
  128. }
  130. return $formats[$this->searchImageFormat];
  131. }
  132. }