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

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