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

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\System\CustomField\CustomFieldDefinition;
  8. use Shopware\Core\System\CustomField\CustomFieldTypes;
  9. use Shopware\Elasticsearch\Framework\ElasticsearchHelper;
  10. use Shopware\Elasticsearch\Framework\ElasticsearchOutdatedIndexDetector;
  11. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  13. class CustomFieldUpdater implements EventSubscriberInterface
  14. {
  15.     private ElasticsearchOutdatedIndexDetector $indexDetector;
  17.     private Client $client;
  19.     private ElasticsearchHelper $elasticsearchHelper;
  21.     /**
  22.      * @internal
  23.      */
  24.     public function __construct(ElasticsearchOutdatedIndexDetector $indexDetector, Client $client, ElasticsearchHelper $elasticsearchHelper)
  25.     {
  26.         $this->indexDetector = $indexDetector;
  27.         $this->client = $client;
  28.         $this->elasticsearchHelper = $elasticsearchHelper;
  29.     }
  31.     public static function getSubscribedEvents(): array
  32.     {
  33.         return [
  34.             EntityWrittenContainerEvent::class => 'onNewCustomFieldCreated',
  35.         ];
  36.     }
  38.     public function onNewCustomFieldCreated(EntityWrittenContainerEvent $containerEvent): void
  39.     {
  40.         $event = $containerEvent->getEventByEntityName(CustomFieldDefinition::ENTITY_NAME);
  42.         if ($event === null) {
  43.             return;
  44.         }
  46.         if (!$this->elasticsearchHelper->allowIndexing()) {
  47.             return;
  48.         }
  50.         $newCreatedFields = [];
  52.         foreach ($event->getWriteResults() as $writeResult) {
  53.             $existence = $writeResult->getExistence();
  55.             if ($existence && $existence->exists()) {
  56.                 continue;
  57.             }
  59.             /** @var array<mixed> $esType */
  60.             $esType = self::getTypeFromCustomFieldType($writeResult->getProperty('type'));
  62.             $newCreatedFields[(string) $writeResult->getProperty('name')] = $esType;
  63.         }
  65.         if (\count($newCreatedFields) === 0) {
  66.             return;
  67.         }
  69.         $this->createNewFieldsInIndices($newCreatedFields);
  70.     }
  72.     /**
  73.      * @deprecated tag:v6.5.0 - Return type will be changed to not nullable - reason:return-type-change
  74.      *
  75.      * @return array<mixed>|null
  76.      */
  77.     public static function getTypeFromCustomFieldType(string $type): ?array
  78.     {
  79.         switch ($type) {
  80.             case CustomFieldTypes::INT:
  81.                 return [
  82.                     'type' => 'long',
  83.                 ];
  84.             case CustomFieldTypes::FLOAT:
  85.                 return [
  86.                     'type' => 'double',
  87.                 ];
  88.             case CustomFieldTypes::BOOL:
  89.                 return [
  90.                     'type' => 'boolean',
  91.                 ];
  92.             case CustomFieldTypes::DATETIME:
  93.                 return [
  94.                     'type' => 'date',
  95.                     'format' => 'yyyy-MM-dd HH:mm:ss.000',
  96.                     'ignore_malformed' => true,
  97.                 ];
  98.             case CustomFieldTypes::JSON:
  99.                 return [
  100.                     'type' => 'object',
  101.                     'dynamic' => true,
  102.                 ];
  103.             case CustomFieldTypes::HTML:
  104.             case CustomFieldTypes::TEXT:
  105.                 return [
  106.                     'type' => 'text',
  107.                 ];
  108.             case CustomFieldTypes::COLORPICKER:
  109.             case CustomFieldTypes::ENTITY:
  110.             case CustomFieldTypes::MEDIA:
  111.             case CustomFieldTypes::SELECT:
  112.             case CustomFieldTypes::SWITCH:
  113.             default:
  114.                 return [
  115.                     'type' => 'keyword',
  116.                 ];
  117.         }
  118.     }
  120.     /**
  121.      * @param array<string, array<mixed>> $newCreatedFields
  122.      */
  123.     private function createNewFieldsInIndices(array $newCreatedFields): void
  124.     {
  125.         $indices = $this->indexDetector->getAllUsedIndices();
  127.         foreach ($indices as $indexName) {
  128.             $body = [
  129.                 'properties' => [
  130.                     'customFields' => [
  131.                         'properties' => $newCreatedFields,
  132.                     ],
  133.                 ],
  134.             ];
  136.             // For some reason, we need to include the includes to prevent merge conflicts.
  137.             // This error can happen for example after updating from version <6.4.
  138.             $current = $this->client->indices()->get(['index' => $indexName]);
  139.             $includes = $current[$indexName]['mappings']['_source']['includes'] ?? [];
  140.             if ($includes !== []) {
  141.                 $body['_source'] = [
  142.                     'includes' => $includes,
  143.                 ];
  144.             }
  146.             $this->client->indices()->putMapping([
  147.                 'index' => $indexName,
  148.                 'body' => $body,
  149.             ]);
  150.         }
  151.     }
  152. }