vendor/ibexa/taxonomy/src/lib/Event/Subscriber/ContentTypeEventsSubscriber.php line 63

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\Taxonomy\Event\Subscriber;
  11. use Ibexa\Contracts\Core\Repository\Events\ContentType\BeforeRemoveFieldDefinitionEvent;
  12. use Ibexa\Contracts\Core\Repository\Events\ContentType\BeforeUpdateFieldDefinitionEvent;
  13. use Ibexa\Contracts\Core\Repository\Values\ContentType\ContentTypeDraft;
  14. use Ibexa\Core\Base\Exceptions\InvalidArgumentException;
  15. use Ibexa\Taxonomy\Service\TaxonomyConfiguration;
  16. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  18. /**
  19. * Throws validation errors when Taxonomy fieldtypes are removed from content type.
  20. *
  21. * This prevents system from becoming corrupted due to broken Taxonomy content type.
  22. *
  23. * @internal
  24. */
  25. final class ContentTypeEventsSubscriber implements EventSubscriberInterface
  26. {
  27. private TaxonomyConfiguration $taxonomyConfiguration;
  29. public function __construct(
  30. TaxonomyConfiguration $taxonomyConfiguration
  31. ) {
  32. $this->taxonomyConfiguration = $taxonomyConfiguration;
  33. }
  35. public static function getSubscribedEvents(): array
  36. {
  37. return [
  38. BeforeRemoveFieldDefinitionEvent::class => 'onRemoveFieldDefinition',
  39. BeforeUpdateFieldDefinitionEvent::class => 'onUpdateFieldDefinition',
  40. ];
  41. }
  43. public function onRemoveFieldDefinition(BeforeRemoveFieldDefinitionEvent $event): void
  44. {
  45. $taxonomy = $this->getTaxonomy($event->getContentTypeDraft());
  46. if (null === $taxonomy) {
  47. return;
  48. }
  50. $fieldMappings = $this->taxonomyConfiguration->getFieldMappings($taxonomy);
  51. $fieldDefinition = $event->getFieldDefinition();
  53. if (!in_array($fieldDefinition->identifier, $fieldMappings, true)) {
  54. return;
  55. }
  57. throw new InvalidArgumentException(
  58. '$fieldDefinition',
  59. 'Cannot remove field definitions used by Taxonomy content type',
  60. );
  61. }
  63. public function onUpdateFieldDefinition(BeforeUpdateFieldDefinitionEvent $event): void
  64. {
  65. $taxonomy = $this->getTaxonomy($event->getContentTypeDraft());
  66. if (null === $taxonomy) {
  67. return;
  68. }
  70. $fieldMappings = $this->taxonomyConfiguration->getFieldMappings($taxonomy);
  71. $fieldDefinition = $event->getFieldDefinition();
  73. if (!in_array($fieldDefinition->identifier, $fieldMappings, true)) {
  74. return;
  75. }
  77. $fieldDefinitionUpdateStruct = $event->getFieldDefinitionUpdateStruct();
  79. if (
  80. null !== $fieldDefinitionUpdateStruct->identifier
  81. && $fieldDefinitionUpdateStruct->identifier !== $fieldDefinition->identifier
  82. ) {
  83. throw new InvalidArgumentException(
  84. '$fieldDefinition',
  85. 'Cannot change field definition identifier used by Taxonomy content type',
  86. );
  87. }
  89. // additional validation for identifier and parent
  90. if (
  91. $fieldDefinition->identifier === $fieldMappings['identifier']
  92. || $fieldDefinition->identifier === $fieldMappings['parent']
  93. ) {
  94. if (
  95. null !== $fieldDefinitionUpdateStruct->isRequired
  96. && $fieldDefinition->isRequired !== $fieldDefinitionUpdateStruct->isRequired
  97. ) {
  98. throw new InvalidArgumentException(
  99. '$fieldDefinition',
  100. 'Cannot change isRequired flag on field definition used by Taxonomy content type',
  101. );
  102. }
  104. if ($fieldDefinitionUpdateStruct->isTranslatable === true) {
  105. throw new InvalidArgumentException(
  106. '$fieldDefinition',
  107. 'Cannot change isTranslatable flag on field definition used by Taxonomy content type',
  108. );
  109. }
  110. }
  111. }
  113. private function getTaxonomy(ContentTypeDraft $contentTypeDraft): ?string
  114. {
  115. if (!$this->taxonomyConfiguration->isContentTypeAssociatedWithTaxonomy($contentTypeDraft)) {
  116. return null;
  117. }
  119. return $this->taxonomyConfiguration->getTaxonomyForContentType($contentTypeDraft);
  120. }
  121. }