platform/src/Elasticsearch/Product/CustomFieldUpdater.php line 35

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.     public function __construct(ElasticsearchOutdatedIndexDetector $indexDetector, Client $client, ElasticsearchHelper $elasticsearchHelper)
  22.     {
  23.         $this->indexDetector = $indexDetector;
  24.         $this->client = $client;
  25.         $this->elasticsearchHelper = $elasticsearchHelper;
  26.     }
  28.     public static function getSubscribedEvents(): array
  29.     {
  30.         return [
  31.             EntityWrittenContainerEvent::class => 'onNewCustomFieldCreated',
  32.         ];
  33.     }
  35.     public function onNewCustomFieldCreated(EntityWrittenContainerEvent $containerEvent): void
  36.     {
  37.         if (!$this->elasticsearchHelper->allowIndexing()) {
  38.             return;
  39.         }
  41.         $event = $containerEvent->getEventByEntityName(CustomFieldDefinition::ENTITY_NAME);
  43.         if ($event === null) {
  44.             return;
  45.         }
  47.         $newCreatedFields = [];
  49.         foreach ($event->getWriteResults() as $writeResult) {
  50.             $existence = $writeResult->getExistence();
  52.             if ($existence && $existence->exists()) {
  53.                 continue;
  54.             }
  56.             $esType = self::getTypeFromCustomFieldType($writeResult->getProperty('type'));
  58.             if ($esType === null) {
  59.                 continue;
  60.             }
  62.             $newCreatedFields[$writeResult->getProperty('name')] = $esType;
  63.         }
  65.         if (\count($newCreatedFields) === 0) {
  66.             return;
  67.         }
  69.         $this->createNewFieldsInIndices($newCreatedFields);
  70.     }
  72.     public static function getTypeFromCustomFieldType(string $type): ?array
  73.     {
  74.         switch ($type) {
  75.             case CustomFieldTypes::INT:
  76.                 return [
  77.                     'type' => 'long',
  78.                 ];
  79.             case CustomFieldTypes::FLOAT:
  80.                 return [
  81.                     'type' => 'double',
  82.                 ];
  83.             case CustomFieldTypes::BOOL:
  84.                 return [
  85.                     'type' => 'boolean',
  86.                 ];
  87.             case CustomFieldTypes::DATETIME:
  88.                 return [
  89.                     'type' => 'date',
  90.                     'format' => 'yyyy-MM-dd HH:mm:ss.000',
  91.                     'ignore_malformed' => true,
  92.                 ];
  93.             case CustomFieldTypes::JSON:
  94.                 return [
  95.                     'type' => 'object',
  96.                     'dynamic' => true,
  97.                 ];
  98.             case CustomFieldTypes::COLORPICKER:
  99.             case CustomFieldTypes::ENTITY:
  100.             case CustomFieldTypes::HTML:
  101.             case CustomFieldTypes::MEDIA:
  102.             case CustomFieldTypes::SELECT:
  103.             case CustomFieldTypes::SWITCH:
  104.             case CustomFieldTypes::TEXT:
  105.             default:
  106.                 return [
  107.                     'type' => 'keyword',
  108.                 ];
  109.         }
  110.     }
  112.     private function createNewFieldsInIndices(array $newCreatedFields): void
  113.     {
  114.         $indices = $this->indexDetector->getAllUsedIndices();
  116.         foreach ($indices as $indexName) {
  117.             $body = [
  118.                 'properties' => [
  119.                     'customFields' => [
  120.                         'properties' => $newCreatedFields,
  121.                     ],
  122.                 ],
  123.             ];
  125.             // For some reason, we need to include the includes to prevent merge conflicts.
  126.             // This error can happen for example after updating from version <6.4.
  127.             $current = $this->client->indices()->get(['index' => $indexName]);
  128.             $includes = $current[$indexName]['mappings']['_source']['includes'] ?? [];
  129.             if ($includes !== []) {
  130.                 $body['_source'] = [
  131.                     'includes' => $includes,
  132.                 ];
  133.             }
  135.             $this->client->indices()->putMapping([
  136.                 'index' => $indexName,
  137.                 'body' => $body,
  138.             ]);
  139.         }
  140.     }
  141. }