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

  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 MediaManagerInterface
  32.      */
  33.     protected $mediaManager;
  35.     /**
  36.      * The format of the image, which will be returned in the search.
  37.      *
  38.      * @var string
  39.      */
  40.     protected $searchImageFormat;
  42.     /**
  43.      * @var Factory
  44.      */
  45.     protected $factory;
  47.     /**
  48.      * @var array
  49.      */
  50.     protected $thumbnailMimeTypes;
  52.     /**
  53.      * @var LoggerInterface
  54.      */
  55.     protected $logger;
  57.     /**
  58.      * @param Factory $factory Massive search factory
  59.      * @param LoggerInterface $logger
  60.      * @param array $thumbnailMimeTypes
  61.      * @param string $searchImageFormat
  62.      */
  63.     public function __construct(
  64.         MediaManagerInterface $mediaManager,
  65.         Factory $factory,
  66.         $thumbnailMimeTypes,
  67.         $searchImageFormat,
  68.         LoggerInterface $logger = null
  69.     ) {
  70.         $this->mediaManager = $mediaManager;
  71.         $this->factory = $factory;
  72.         $this->searchImageFormat = $searchImageFormat;
  73.         $this->thumbnailMimeTypes = $thumbnailMimeTypes;
  74.         $this->logger = $logger ?: new NullLogger();
  75.     }
  77.     public static function getSubscribedEvents()
  78.     {
  79.         return [
  80.             SearchEvents::PRE_INDEX => 'handlePreIndex',
  81.         ];
  82.     }
  84.     /**
  85.      * Adds the image to the search document.
  86.      */
  87.     public function handlePreIndex(PreIndexEvent $event)
  88.     {
  89.         $metadata = $event->getMetadata();
  91.         if (
  92.             !$event->getSubject() instanceof FileVersionMeta
  93.             && FileVersionMeta::class !== $metadata->getName()
  94.         ) {
  95.             return;
  96.         }
  98.         $document = $event->getDocument();
  99.         $subject = $event->getSubject();
  100.         $locale = $subject->getLocale();
  102.         $fileVersion = $subject->getFileVersion();
  103.         $file = $fileVersion->getFile();
  104.         $media = $file->getMedia();
  106.         // Do not try and get the image URL if the mime type is not in the
  107.         // list of mime types for which thumbnails are generated.
  108.         foreach ($this->thumbnailMimeTypes as $type) {
  109.             if (\fnmatch($type, $fileVersion->getMimeType())) {
  110.                 $document->setImageUrl($this->getImageUrl($media, $locale));
  111.                 break;
  112.             }
  113.         }
  115.         $document->addField($this->factory->createField(
  116.             'media_id',
  117.             $media->getId()
  118.         ));
  120.         $document->addField($this->factory->createField(
  121.             'media_mime',
  122.             $fileVersion->getMimeType()
  123.         ));
  125.         if ($collection = $media->getCollection()) {
  126.             $document->addField($this->factory->createField(
  127.                 'collection_id',
  128.                 $collection->getId()
  129.             ));
  130.         }
  131.     }
  133.     /**
  134.      * Return the image URL for the given media.
  135.      *
  136.      * TODO: The media API needs to be improved here.
  137.      */
  138.     private function getImageUrl($media, $locale)
  139.     {
  140.         $mediaApi = new Media($media, $locale);
  141.         $this->mediaManager->addFormatsAndUrl($mediaApi);
  142.         $formats = $mediaApi->getThumbnails();
  144.         if (!isset($formats[$this->searchImageFormat])) {
  145.             $this->logger->warning(\sprintf(
  146.                 'Media with ID "%s" does not have thumbnail format "%s". This thumbnail would be used by the search results.',
  147.                 $media->getId(),
  148.                 $this->searchImageFormat
  149.             ));
  151.             return;
  152.         }
  154.         return $formats[$this->searchImageFormat];
  155.     }
  156. }