vendor/shopware/elasticsearch/Product/CustomFieldUpdater.php line 43

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Elasticsearch\Product;
  5. use Elasticsearch\Client;
  6. use Shopware\Core\Framework\DataAbstractionLayer\Event\EntityWrittenContainerEvent;
  7. use Shopware\Core\Framework\Log\Package;
  8. use Shopware\Core\System\CustomField\CustomFieldDefinition;
  9. use Shopware\Core\System\CustomField\CustomFieldTypes;
  10. use Shopware\Elasticsearch\Framework\ElasticsearchHelper;
  11. use Shopware\Elasticsearch\Framework\ElasticsearchOutdatedIndexDetector;
  12. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  14. /**
  15. * @deprecated tag:v6.5.0 - reason:becomes-internal - EventSubscribers will become internal in v6.5.0
  16. */
  17. #[Package('core')]
  18. class CustomFieldUpdater implements EventSubscriberInterface
  19. {
  20. private ElasticsearchOutdatedIndexDetector $indexDetector;
  22. private Client $client;
  24. private ElasticsearchHelper $elasticsearchHelper;
  26. /**
  27. * @internal
  28. */
  29. public function __construct(ElasticsearchOutdatedIndexDetector $indexDetector, Client $client, ElasticsearchHelper $elasticsearchHelper)
  30. {
  31. $this->indexDetector = $indexDetector;
  32. $this->client = $client;
  33. $this->elasticsearchHelper = $elasticsearchHelper;
  34. }
  36. public static function getSubscribedEvents(): array
  37. {
  38. return [
  39. EntityWrittenContainerEvent::class => 'onNewCustomFieldCreated',
  40. ];
  41. }
  43. public function onNewCustomFieldCreated(EntityWrittenContainerEvent $containerEvent): void
  44. {
  45. $event = $containerEvent->getEventByEntityName(CustomFieldDefinition::ENTITY_NAME);
  47. if ($event === null) {
  48. return;
  49. }
  51. if (!$this->elasticsearchHelper->allowIndexing()) {
  52. return;
  53. }
  55. $newCreatedFields = [];
  57. foreach ($event->getWriteResults() as $writeResult) {
  58. $existence = $writeResult->getExistence();
  60. if ($existence && $existence->exists()) {
  61. continue;
  62. }
  64. /** @var array<mixed> $esType */
  65. $esType = self::getTypeFromCustomFieldType($writeResult->getProperty('type'));
  67. $newCreatedFields[(string) $writeResult->getProperty('name')] = $esType;
  68. }
  70. if (\count($newCreatedFields) === 0) {
  71. return;
  72. }
  74. $this->createNewFieldsInIndices($newCreatedFields);
  75. }
  77. /**
  78. * @deprecated tag:v6.5.0 - Return type will be changed to not nullable - reason:return-type-change
  79. *
  80. * @return array<mixed>|null
  81. */
  82. public static function getTypeFromCustomFieldType(string $type): ?array
  83. {
  84. switch ($type) {
  85. case CustomFieldTypes::INT:
  86. return [
  87. 'type' => 'long',
  88. ];
  89. case CustomFieldTypes::FLOAT:
  90. return [
  91. 'type' => 'double',
  92. ];
  93. case CustomFieldTypes::BOOL:
  94. return [
  95. 'type' => 'boolean',
  96. ];
  97. case CustomFieldTypes::DATETIME:
  98. return [
  99. 'type' => 'date',
  100. 'format' => 'yyyy-MM-dd HH:mm:ss.000',
  101. 'ignore_malformed' => true,
  102. ];
  103. case CustomFieldTypes::PRICE:
  104. case CustomFieldTypes::JSON:
  105. return [
  106. 'type' => 'object',
  107. 'dynamic' => true,
  108. ];
  109. case CustomFieldTypes::HTML:
  110. case CustomFieldTypes::TEXT:
  111. return [
  112. 'type' => 'text',
  113. ];
  114. case CustomFieldTypes::COLORPICKER:
  115. case CustomFieldTypes::ENTITY:
  116. case CustomFieldTypes::MEDIA:
  117. case CustomFieldTypes::SELECT:
  118. case CustomFieldTypes::SWITCH:
  119. default:
  120. return [
  121. 'type' => 'keyword',
  122. ];
  123. }
  124. }
  126. /**
  127. * @param array<string, array<mixed>> $newCreatedFields
  128. */
  129. private function createNewFieldsInIndices(array $newCreatedFields): void
  130. {
  131. $indices = $this->indexDetector->getAllUsedIndices();
  133. foreach ($indices as $indexName) {
  134. $body = [
  135. 'properties' => [
  136. 'customFields' => [
  137. 'properties' => $newCreatedFields,
  138. ],
  139. ],
  140. ];
  142. // For some reason, we need to include the includes to prevent merge conflicts.
  143. // This error can happen for example after updating from version <6.4.
  144. $current = $this->client->indices()->get(['index' => $indexName]);
  145. $includes = $current[$indexName]['mappings']['_source']['includes'] ?? [];
  146. if ($includes !== []) {
  147. $body['_source'] = [
  148. 'includes' => $includes,
  149. ];
  150. }
  152. $this->client->indices()->putMapping([
  153. 'index' => $indexName,
  154. 'body' => $body,
  155. ]);
  156. }
  157. }
  158. }