vendor/shopware/core/Framework/DataAbstractionLayer/FieldSerializer/CustomFieldsSerializer.php line 87

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Framework\DataAbstractionLayer\FieldSerializer;
  5. use Shopware\Core\Framework\DataAbstractionLayer\DefinitionInstanceRegistry;
  6. use Shopware\Core\Framework\DataAbstractionLayer\Exception\InvalidSerializerFieldException;
  7. use Shopware\Core\Framework\DataAbstractionLayer\Field\CustomFields;
  8. use Shopware\Core\Framework\DataAbstractionLayer\Field\Field;
  9. use Shopware\Core\Framework\DataAbstractionLayer\Field\JsonField;
  10. use Shopware\Core\Framework\DataAbstractionLayer\Write\Command\JsonUpdateCommand;
  11. use Shopware\Core\Framework\DataAbstractionLayer\Write\DataStack\KeyValuePair;
  12. use Shopware\Core\Framework\DataAbstractionLayer\Write\EntityExistence;
  13. use Shopware\Core\Framework\DataAbstractionLayer\Write\WriteParameterBag;
  14. use Shopware\Core\Framework\Log\Package;
  15. use Shopware\Core\Framework\Util\Json;
  16. use Shopware\Core\Framework\Uuid\Uuid;
  17. use Shopware\Core\System\CustomField\CustomFieldService;
  18. use Symfony\Component\Validator\Validator\ValidatorInterface;
  20. /**
  21.  * @internal
  22.  */
  23. #[Package('core')]
  24. class CustomFieldsSerializer extends JsonFieldSerializer
  25. {
  26.     public function __construct(
  27.         DefinitionInstanceRegistry $definitionRegistry,
  28.         ValidatorInterface $validator,
  29.         private readonly CustomFieldService $attributeService
  30.     ) {
  31.         parent::__construct($validator, $definitionRegistry);
  32.     }
  34.     public function encode(Field $field, EntityExistence $existence, KeyValuePair $data, WriteParameterBag $parameters): \Generator
  35.     {
  36.         if (!$field instanceof CustomFields) {
  37.             throw new InvalidSerializerFieldException(CustomFields::class, $field);
  38.         }
  40.         $this->validateIfNeeded($field, $existence, $data, $parameters);
  42.         $attributes = $data->getValue();
  43.         if ($attributes === null) {
  44.             yield $field->getStorageName() => null;
  46.             return;
  47.         }
  49.         if (empty($attributes)) {
  50.             yield $field->getStorageName() => '{}';
  52.             return;
  53.         }
  55.         // set fields dynamically
  56.         /** @var array<string, mixed> $attributes */
  57.         $field->setPropertyMapping($this->getFields(array_keys($attributes)));
  58.         $encoded = $this->validateMapping($field, $attributes, $parameters);
  60.         if (empty($encoded)) {
  61.             return;
  62.         }
  64.         if ($existence->exists()) {
  65.             $this->extractJsonUpdate([$field->getStorageName() => $encoded], $existence, $parameters);
  67.             return;
  68.         }
  70.         yield $field->getStorageName() => Json::encode($encoded);
  71.     }
  73.     /**
  74.      * @return array<string, mixed>|object|null
  75.      */
  76.     public function decode(Field $field, mixed $value): array|object|null
  77.     {
  78.         if (!$field instanceof CustomFields) {
  79.             throw new InvalidSerializerFieldException(CustomFields::class, $field);
  80.         }
  82.         if ($value) {
  83.             // set fields dynamically
  84.             /** @var array<string> $attributes */
  85.             $attributes = array_keys(json_decode((string) $value, true, 512, \JSON_THROW_ON_ERROR));
  87.             $field->setPropertyMapping($this->getFields($attributes));
  88.         }
  90.         return parent::decode($field, $value);
  91.     }
  93.     /**
  94.      * @param array<string> $attributeNames
  95.      *
  96.      * @return array<Field>
  97.      */
  98.     private function getFields(array $attributeNames): array
  99.     {
  100.         $fields = [];
  101.         foreach ($attributeNames as $attributeName) {
  102.             $fields[] = $this->attributeService->getCustomField($attributeName)
  103.                 ?? new JsonField($attributeName, $attributeName);
  104.         }
  106.         return $fields;
  107.     }
  109.     /**
  110.      * @param array<string, array<string, mixed>> $data
  111.      */
  112.     private function extractJsonUpdate(array $data, EntityExistence $existence, WriteParameterBag $parameters): void
  113.     {
  114.         foreach ($data as $storageName => $attributes) {
  115.             $entityName = $existence->getEntityName();
  116.             if (!$entityName) {
  117.                 continue;
  118.             }
  120.             $definition = $this->definitionRegistry->getByEntityName($entityName);
  122.             $pks = Uuid::fromHexToBytesList($existence->getPrimaryKey());
  124.             $jsonUpdateCommand = new JsonUpdateCommand(
  125.                 $definition,
  126.                 $storageName,
  127.                 $attributes,
  128.                 $pks,
  129.                 $existence,
  130.                 $parameters->getPath()
  131.             );
  133.             $parameters->getCommandQueue()->add($jsonUpdateCommand->getDefinition(), $jsonUpdateCommand);
  134.         }
  135.     }
  136. }