vendor/ibexa/fieldtype-page/src/lib/Event/Subscriber/AddMissingAttributesOnLoadSubscriber.php line 50

Open in your IDE?
  1. <?php
  3. /**
  4. * @copyright Copyright (C) Ibexa AS. All rights reserved.
  5. * @license For full copyright and license information view LICENSE file distributed with this source code.
  6. */
  7. declare(strict_types=1);
  9. namespace Ibexa\FieldTypePage\Event\Subscriber;
  11. use Ibexa\Contracts\FieldTypePage\FieldType\LandingPage\Model\Attribute;
  12. use Ibexa\Contracts\FieldTypePage\FieldType\LandingPage\Model\BlockValue;
  13. use Ibexa\Contracts\FieldTypePage\FieldType\Page\Block\Definition\BlockDefinition;
  14. use Ibexa\FieldTypePage\Event\PageEvents;
  15. use Ibexa\FieldTypePage\Event\PageFromPersistenceEvent;
  16. use Ibexa\FieldTypePage\FieldType\Page\Block\Definition\BlockDefinitionFactoryInterface;
  17. use Ibexa\FieldTypePage\Serializer\AttributeSerializationDispatcher;
  18. use Ramsey\Uuid\Uuid;
  19. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  21. class AddMissingAttributesOnLoadSubscriber implements EventSubscriberInterface
  22. {
  23. /** @var \Ibexa\FieldTypePage\FieldType\Page\Block\Definition\BlockDefinitionFactoryInterface */
  24. private $blockDefinitionFactory;
  26. /** @var \Ibexa\FieldTypePage\Serializer\AttributeSerializationDispatcher */
  27. private $attributeSerializationDispatcher;
  29. public function __construct(
  30. BlockDefinitionFactoryInterface $blockDefinitionFactory,
  31. AttributeSerializationDispatcher $attributeSerializationDispatcher
  32. ) {
  33. $this->blockDefinitionFactory = $blockDefinitionFactory;
  34. $this->attributeSerializationDispatcher = $attributeSerializationDispatcher;
  35. }
  37. /**
  38. * {@inheritdoc}
  39. */
  40. public static function getSubscribedEvents(): array
  41. {
  42. return [
  43. PageEvents::PERSISTENCE_FROM => ['onLoadFromPersistence', 100],
  44. ];
  45. }
  47. /**
  48. * @param \Ibexa\FieldTypePage\Event\PageFromPersistenceEvent $event
  49. */
  50. public function onLoadFromPersistence(PageFromPersistenceEvent $event): void
  51. {
  52. $value = $event->getValue();
  53. $page = $value->getPage();
  55. // local cache to save roundtrips to redis/fs cache
  56. $visitedBlockDefinitions = [];
  57. foreach ($page->getZones() as $zone) {
  58. foreach ($zone->getBlocks() as $block) {
  59. $type = $block->getType();
  61. $blockDefinition = $this->getBlockDefinition($type, $visitedBlockDefinitions);
  62. $visitedBlockDefinitions[$type] = $blockDefinition;
  64. $block->setAttributes(
  65. array_merge($block->getAttributes(), $this->getMissingAttributes($block, $blockDefinition))
  66. );
  67. }
  68. }
  70. $event->setValue($value);
  71. }
  73. /**
  74. * @return \Ibexa\Contracts\FieldTypePage\FieldType\LandingPage\Model\Attribute[]
  75. */
  76. private function getMissingAttributes(BlockValue $block, BlockDefinition $blockDefinition): array
  77. {
  78. $missingAttributes = [];
  79. foreach ($blockDefinition->getAttributes() as $attributeDefinition) {
  80. if ($this->hasAttribute($block, $attributeDefinition->getIdentifier())) {
  81. continue;
  82. }
  84. $deserializedValue = $this->attributeSerializationDispatcher->deserialize(
  85. $block,
  86. $attributeDefinition->getIdentifier(),
  87. $attributeDefinition->getValue()
  88. );
  90. $missingAttributes[] = new Attribute(
  91. Uuid::uuid1()->toString(),
  92. $attributeDefinition->getIdentifier(),
  93. $deserializedValue
  94. );
  95. }
  97. return $missingAttributes;
  98. }
  100. /**
  101. * @param \Ibexa\Contracts\FieldTypePage\FieldType\LandingPage\Model\BlockValue $blockValue
  102. * @param string $attributeIdentifier
  103. *
  104. * @return bool
  105. */
  106. private function hasAttribute(BlockValue $blockValue, string $attributeIdentifier): bool
  107. {
  108. foreach ($blockValue->getAttributes() as $attribute) {
  109. if ($attribute->getName() === $attributeIdentifier) {
  110. return true;
  111. }
  112. }
  114. return false;
  115. }
  117. private function getBlockDefinition(string $type, array $visitedBlockDefinitions): BlockDefinition
  118. {
  119. return $visitedBlockDefinitions[$type] ?? $this->blockDefinitionFactory->getBlockDefinition($type);
  120. }
  121. }
  123. class_alias(AddMissingAttributesOnLoadSubscriber::class, 'EzSystems\EzPlatformPageFieldType\Event\Subscriber\AddMissingAttributesOnLoadSubscriber');