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

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\PageBundle\Search\EventSubscriber;
  14. use Doctrine\ORM\EntityManagerInterface;
  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. public function __construct(private Factory $factory, private EntityManagerInterface $entityManager)
  35. {
  36. }
  38. public static function getSubscribedEvents()
  39. {
  40. return [
  41. SearchEvents::PRE_INDEX => 'handleBlameTimestamp',
  42. SearchEvents::HIT => 'handleBlameTimestampHitMapping',
  43. ];
  44. }
  46. /**
  47. * Map blame and timestamp information to the search document.
  48. */
  49. public function handleBlameTimestamp(PreIndexEvent $event)
  50. {
  51. $subject = $event->getSubject();
  52. $document = $event->getDocument();
  54. if ($subject instanceof UserBlameInterface) {
  55. $this->mapCreatorAndChanger($document, $subject->getCreator(), $subject->getChanger());
  56. }
  58. if ($subject instanceof TimestampableInterface) {
  59. $this->mapTimestamp($document, $subject->getCreated(), $subject->getChanged());
  60. }
  61. }
  63. /**
  64. * Map the changer and created from the field data to
  65. * the search document (we don't include the field data in the search result API).
  66. */
  67. public function handleBlameTimestampHitMapping(HitEvent $event)
  68. {
  69. $document = $event->getHit()->getDocument();
  70. $this->doHandleBlameTimestampHitMapping($document);
  71. }
  73. private function doHandleBlameTimestampHitMapping(Document $document)
  74. {
  75. $document->setCreatorName($this->getFieldValue($document, 'creator'));
  76. $document->setChangerName($this->getFieldValue($document, 'changer'));
  77. $document->setCreatorId($this->getFieldValue($document, 'creator_id'));
  78. $document->setChangerId($this->getFieldValue($document, 'changer_id'));
  79. $document->setCreated($this->getFieldValue($document, 'created'));
  80. $document->setChanged($this->getFieldValue($document, 'changed'));
  81. }
  83. /**
  84. * Return the named field from the document or return null.
  85. */
  86. private function getFieldValue($document, $fieldName)
  87. {
  88. if (false === $document->hasField($fieldName)) {
  89. return;
  90. }
  92. return $document->getField($fieldName)->getValue();
  93. }
  95. /**
  96. * Map timestamps to the search document.
  97. */
  98. private function mapTimestamp(Document $document, ?\DateTime $created = null, ?\DateTime $changed = null)
  99. {
  100. $document->addField(
  101. $this->factory->createField('created', $created ? $created->format('c') : null, 'string')
  102. );
  104. $document->addField(
  105. $this->factory->createField('changed', $changed ? $changed->format('c') : null, 'string')
  106. );
  107. }
  109. /**
  110. * Map the creator and changer to the document.
  111. */
  112. private function mapCreatorAndChanger(Document $document, ?UserInterface $creator = null, ?UserInterface $changer = null)
  113. {
  114. $document->addField(
  115. $this->factory->createField('changer', $changer ? $changer->getUserIdentifier() : null, 'string')
  116. );
  117. $document->addField(
  118. $this->factory->createField('changer_id', $changer ? $changer->getId() : null, 'string')
  119. );
  121. $document->addField(
  122. $this->factory->createField('creator', $creator ? $creator->getUserIdentifier() : null, 'string')
  123. );
  124. $document->addField(
  125. $this->factory->createField('creator_id', $creator ? $creator->getId() : null, 'string')
  126. );
  127. }
  128. }