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

  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.      * @var MediaManagerInterface
  30.      */
  31.     protected $mediaManager;
  33.     /**
  34.      * @var RequestAnalyzerInterface
  35.      */
  36.     protected $requestAnalyzer;
  38.     /**
  39.      * The format of the image, which will be returned in the search.
  40.      *
  41.      * @var string
  42.      */
  43.     protected $searchImageFormat;
  45.     /**
  46.      * @param RequestAnalyzerInterface $requestAnalyzer
  47.      * @param string $searchImageFormat
  48.      */
  49.     public function __construct(
  50.         MediaManagerInterface $mediaManager,
  51.         RequestAnalyzerInterface $requestAnalyzer = null,
  52.         $searchImageFormat
  53.     ) {
  54.         $this->mediaManager = $mediaManager;
  55.         $this->requestAnalyzer = $requestAnalyzer;
  56.         $this->searchImageFormat = $searchImageFormat;
  57.     }
  59.     /**
  60.      * Returns the events this subscriber has subscribed.
  61.      *
  62.      * @return array
  63.      */
  64.     public static function getSubscribedEvents()
  65.     {
  66.         return [
  67.             SearchEvents::PRE_INDEX => 'handlePreIndex',
  68.         ];
  69.     }
  71.     /**
  72.      * Adds the image to the search document.
  73.      */
  74.     public function handlePreIndex(PreIndexEvent $e)
  75.     {
  76.         $metadata = $e->getMetadata();
  77.         $document = $e->getDocument();
  78.         $subject = $e->getSubject();
  79.         $evaluator = $e->getFieldEvaluator();
  81.         if (
  82.             !$e->getSubject() instanceof StructureBehavior
  83.             && StructureBehavior::class !== $metadata->getName()
  84.         ) {
  85.             return;
  86.         }
  88.         if (!$imageUrlField = $metadata->getImageUrlField()) {
  89.             return;
  90.         }
  92.         $data = $evaluator->getValue($subject, $imageUrlField);
  93.         $locale = $subject->getLocale();
  95.         if (!$data) {
  96.             $document->setImageUrl(null);
  98.             return;
  99.         }
  101.         $imageUrl = $this->getImageUrl($data, $locale);
  102.         $document->setImageUrl($imageUrl);
  103.     }
  105.     /**
  106.      * Returns the url for the image.
  107.      *
  108.      * @param array|MediaSelectionContainer $data
  109.      * @param string $locale
  110.      *
  111.      * @return string|null
  112.      *
  113.      * @throws \RuntimeException
  114.      * @throws \InvalidArgumentException
  115.      */
  116.     private function getImageUrl($data, $locale)
  117.     {
  118.         // new structures will container an instance of MediaSelectionContainer
  119.         if ($data instanceof MediaSelectionContainer) {
  120.             $medias = $data->getData();
  121.         // old ones an array ...
  122.         } else {
  123.             $ids = [];
  125.             if (isset($data['ids'])) {
  126.                 $ids = \array_merge($ids, $data['ids']);
  127.             } elseif (isset($data['id'])) {
  128.                 $ids = \array_merge($ids, [$data['id']]);
  129.             }
  131.             if (0 === \count($ids)) {
  132.                 return null;
  133.             }
  135.             $medias = $this->mediaManager->get($locale, [
  136.                 'ids' => $ids,
  137.             ]);
  138.         }
  140.         // no media, no thumbnail URL
  141.         if (!$medias) {
  142.             return null;
  143.         }
  145.         $media = \current($medias);
  147.         if (!$media) {
  148.             return null;
  149.         }
  151.         $formats = $media->getThumbnails();
  153.         if (empty($formats)) {
  154.             return null;
  155.         }
  157.         if (!isset($formats[$this->searchImageFormat])) {
  158.             throw new \InvalidArgumentException(
  159.                 \sprintf('Search image format "%s" is not known', $this->searchImageFormat)
  160.             );
  161.         }
  163.         return $formats[$this->searchImageFormat];
  164.     }
  165. }