vendor/sulu/sulu/src/Sulu/Bundle/PageBundle/Search/EventSubscriber/BlameTimestampSubscriber.php line 79

  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\PageBundle\Search\EventSubscriber;
  14. use Doctrine\ORM\EntityManager;
  15. use Massive\Bundle\SearchBundle\Search\Event\HitEvent;
  16. use Massive\Bundle\SearchBundle\Search\Event\PreIndexEvent;
  17. use Massive\Bundle\SearchBundle\Search\Factory;
  18. use Massive\Bundle\SearchBundle\Search\SearchEvents;
  19. use Sulu\Bundle\SearchBundle\Search\Document;
  20. use Sulu\Component\Persistence\Model\TimestampableInterface;
  21. use Sulu\Component\Persistence\Model\UserBlameInterface;
  22. use Sulu\Component\Security\Authentication\UserInterface;
  23. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  25. /**
  26.  * Add blame (creator, changor) and timestamp (created, changed) to
  27.  * the document before it is indexed.
  28.  *
  29.  * Works for objects implementing interfaces (UserBlameInterface and
  30.  * TimestampableInterface).
  31.  */
  32. class BlameTimestampSubscriber implements EventSubscriberInterface
  33. {
  34.     /**
  35.      * @var Factory
  36.      */
  37.     private $factory;
  39.     /**
  40.      * @var EntityManager
  41.      */
  42.     private $entityManager;
  44.     public function __construct(Factory $factory, EntityManager $entityManager)
  45.     {
  46.         $this->factory = $factory;
  47.         $this->entityManager = $entityManager;
  48.     }
  50.     public static function getSubscribedEvents()
  51.     {
  52.         return [
  53.             SearchEvents::PRE_INDEX => 'handleBlameTimestamp',
  54.             SearchEvents::HIT => 'handleBlameTimestampHitMapping',
  55.         ];
  56.     }
  58.     /**
  59.      * Map blame and timestamp information to the search document.
  60.      */
  61.     public function handleBlameTimestamp(PreIndexEvent $event)
  62.     {
  63.         $subject = $event->getSubject();
  64.         $document = $event->getDocument();
  66.         if ($subject instanceof UserBlameInterface) {
  67.             $this->mapCreatorAndChanger($document, $subject->getCreator(), $subject->getChanger());
  68.         }
  70.         if ($subject instanceof TimestampableInterface) {
  71.             $this->mapTimestamp($document, $subject->getCreated(), $subject->getChanged());
  72.         }
  73.     }
  75.     /**
  76.      * Map the changer and created from the field data to
  77.      * the search document (we don't include the field data in the search result API).
  78.      */
  79.     public function handleBlameTimestampHitMapping(HitEvent $event)
  80.     {
  81.         $document = $event->getHit()->getDocument();
  82.         $this->doHandleBlameTimestampHitMapping($document);
  83.     }
  85.     private function doHandleBlameTimestampHitMapping(Document $document)
  86.     {
  87.         $document->setCreatorName($this->getFieldValue($document, 'creator'));
  88.         $document->setChangerName($this->getFieldValue($document, 'changer'));
  89.         $document->setCreatorId($this->getFieldValue($document, 'creator_id'));
  90.         $document->setChangerId($this->getFieldValue($document, 'changer_id'));
  91.         $document->setCreated($this->getFieldValue($document, 'created'));
  92.         $document->setChanged($this->getFieldValue($document, 'changed'));
  93.     }
  95.     /**
  96.      * Return the named field from the document or return null.
  97.      */
  98.     private function getFieldValue($document, $fieldName)
  99.     {
  100.         if (false === $document->hasField($fieldName)) {
  101.             return;
  102.         }
  104.         return $document->getField($fieldName)->getValue();
  105.     }
  107.     /**
  108.      * Map timestamps to the search document.
  109.      *
  110.      * @param \DateTime $created
  111.      * @param \DateTime $changed
  112.      */
  113.     private function mapTimestamp(Document $document, \DateTime $created = null, \DateTime $changed = null)
  114.     {
  115.         $document->addField(
  116.             $this->factory->createField('created', $created ? $created->format('c') : null, 'string')
  117.         );
  119.         $document->addField(
  120.             $this->factory->createField('changed', $changed ? $changed->format('c') : null, 'string')
  121.         );
  122.     }
  124.     /**
  125.      * Map the creator and changer to the document.
  126.      *
  127.      * @param UserInterface $creator
  128.      * @param UserInterface $changer
  129.      */
  130.     private function mapCreatorAndChanger(Document $document, UserInterface $creator = null, UserInterface $changer = null)
  131.     {
  132.         $document->addField(
  133.             $this->factory->createField('changer', $changer ? $changer->getUserIdentifier() : null, 'string')
  134.         );
  135.         $document->addField(
  136.             $this->factory->createField('changer_id', $changer ? $changer->getId() : null, 'string')
  137.         );
  139.         $document->addField(
  140.             $this->factory->createField('creator', $creator ? $creator->getUserIdentifier() : null, 'string')
  141.         );
  142.         $document->addField(
  143.             $this->factory->createField('creator_id', $creator ? $creator->getId() : null, 'string')
  144.         );
  145.     }
  146. }