src/Core/Framework/DataAbstractionLayer/FieldSerializer/CustomFieldsSerializer.php line 93

  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\DataStack\KeyValuePair;
  11. use Shopware\Core\Framework\DataAbstractionLayer\Write\EntityExistence;
  12. use Shopware\Core\Framework\DataAbstractionLayer\Write\WriteCommandExtractor;
  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\System\CustomField\CustomFieldService;
  17. use Symfony\Component\Validator\Validator\ValidatorInterface;
  19. /**
  20.  * @internal
  21.  */
  22. #[Package('core')]
  23. class CustomFieldsSerializer extends JsonFieldSerializer
  24. {
  25.     /**
  26.      * @internal
  27.      */
  28.     public function __construct(
  29.         DefinitionInstanceRegistry $compositeHandler,
  30.         ValidatorInterface $validator,
  31.         private readonly CustomFieldService $attributeService,
  32.         private readonly WriteCommandExtractor $writeExtractor
  33.     ) {
  34.         parent::__construct($validator, $compositeHandler);
  35.     }
  37.     public function encode(Field $field, EntityExistence $existence, KeyValuePair $data, WriteParameterBag $parameters): \Generator
  38.     {
  39.         if (!$field instanceof CustomFields) {
  40.             throw new InvalidSerializerFieldException(CustomFields::class, $field);
  41.         }
  43.         $this->validateIfNeeded($field, $existence, $data, $parameters);
  45.         $attributes = $data->getValue();
  46.         if ($attributes === null) {
  47.             yield $field->getStorageName() => null;
  49.             return;
  50.         }
  52.         if (empty($attributes)) {
  53.             yield $field->getStorageName() => '{}';
  55.             return;
  56.         }
  58.         // set fields dynamically
  59.         $field->setPropertyMapping($this->getFields(array_keys($attributes)));
  60.         $encoded = $this->validateMapping($field, $attributes, $parameters);
  62.         if (empty($encoded)) {
  63.             return;
  64.         }
  66.         if ($existence->exists()) {
  67.             $this->writeExtractor->extractJsonUpdate([$field->getStorageName() => $encoded], $existence, $parameters);
  69.             return;
  70.         }
  72.         yield $field->getStorageName() => Json::encode($encoded);
  73.     }
  75.     public function decode(Field $field, mixed $value): array|object|null
  76.     {
  77.         if (!$field instanceof CustomFields) {
  78.             throw new InvalidSerializerFieldException(CustomFields::class, $field);
  79.         }
  81.         if ($value) {
  82.             // set fields dynamically
  83.             $field->setPropertyMapping($this->getFields(array_keys(json_decode((string) $value, true, 512, \JSON_THROW_ON_ERROR))));
  84.         }
  86.         return parent::decode($field, $value);
  87.     }
  89.     private function getFields(array $attributeNames): array
  90.     {
  91.         $fields = [];
  92.         foreach ($attributeNames as $attributeName) {
  93.             $fields[] = $this->attributeService->getCustomField($attributeName)
  94.                 ?? new JsonField($attributeName, $attributeName);
  95.         }
  97.         return $fields;
  98.     }
  99. }