vendor/shopware/core/Framework/DataAbstractionLayer/FieldSerializer/ListFieldSerializer.php line 74

Open in your IDE?
  1. <?php
  2. declare(strict_types=1);
  4. namespace Shopware\Core\Framework\DataAbstractionLayer\FieldSerializer;
  6. use Shopware\Core\Framework\DataAbstractionLayer\DefinitionInstanceRegistry;
  7. use Shopware\Core\Framework\DataAbstractionLayer\Exception\InvalidSerializerFieldException;
  8. use Shopware\Core\Framework\DataAbstractionLayer\Field\Field;
  9. use Shopware\Core\Framework\DataAbstractionLayer\Field\ListField;
  10. use Shopware\Core\Framework\DataAbstractionLayer\Write\DataStack\KeyValuePair;
  11. use Shopware\Core\Framework\DataAbstractionLayer\Write\EntityExistence;
  12. use Shopware\Core\Framework\DataAbstractionLayer\Write\FieldException\WriteFieldException;
  13. use Shopware\Core\Framework\DataAbstractionLayer\Write\WriteParameterBag;
  14. use Shopware\Core\Framework\Feature;
  15. use Symfony\Component\Validator\Constraints\Type;
  16. use Symfony\Component\Validator\Validator\ValidatorInterface;
  18. /**
  19.  * @deprecated tag:v6.5.0 - reason:becomes-internal - Will be internal
  20.  */
  21. class ListFieldSerializer extends AbstractFieldSerializer
  22. {
  23.     /**
  24.      * @internal
  25.      */
  26.     public function __construct(
  27.         ValidatorInterface $validator,
  28.         DefinitionInstanceRegistry $definitionRegistry
  29.     ) {
  30.         parent::__construct($validator, $definitionRegistry);
  31.     }
  33.     /**
  34.      * @throws InvalidSerializerFieldException
  35.      */
  36.     public function encode(
  37.         Field $field,
  38.         EntityExistence $existence,
  39.         KeyValuePair $data,
  40.         WriteParameterBag $parameters
  41.     ): \Generator {
  42.         if (!$field instanceof ListField) {
  43.             throw new InvalidSerializerFieldException(ListField::class, $field);
  44.         }
  46.         $this->validateIfNeeded($field, $existence, $data, $parameters);
  48.         $value = $data->getValue();
  50.         if ($value !== null) {
  51.             $value = array_values($value);
  53.             $this->validateTypes($field, $value, $parameters);
  55.             $value = JsonFieldSerializer::encodeJson($value);
  56.         }
  58.         yield $field->getStorageName() => $value;
  59.     }
  61.     /**
  62.      * @return array|null
  63.      *
  64.      * @deprecated tag:v6.5.0 - reason:return-type-change - The return type will be native typed
  65.      */
  66.     public function decode(Field $field, $value)/* ?array*/
  67.     {
  68.         if ($value === null) {
  69.             return null;
  70.         }
  72.         /** @deprecated tag:v6.5.0 - remove whole is block as the `strict` behaviour will always be used */
  73.         if (!Feature::isActive('v6.5.0.0')) {
  74.             if ($field instanceof ListField && $field->isStrict()) {
  75.                 return array_values(json_decode($value, true));
  76.             }
  78.             return json_decode($value, true);
  79.         }
  81.         return array_values(json_decode($value, true));
  82.     }
  84.     protected function getConstraints(Field $field): array
  85.     {
  86.         return [new Type('array')];
  87.     }
  89.     protected function validateTypes(ListField $field, array $values, WriteParameterBag $parameters): void
  90.     {
  91.         $fieldType = $field->getFieldType();
  92.         if ($fieldType === null) {
  93.             return;
  94.         }
  96.         $existence = new EntityExistence(null, [], false, false, false, []);
  98.         /** @var Field $listField */
  99.         $listField = new $fieldType('key', 'key');
  100.         $listField->compile($this->definitionRegistry);
  102.         $nestedParameters = $parameters->cloneForSubresource(
  103.             $parameters->getDefinition(),
  104.             $parameters->getPath() . '/' . $field->getPropertyName()
  105.         );
  107.         foreach ($values as $i => $value) {
  108.             try {
  109.                 $kvPair = new KeyValuePair((string) $i, $value, true);
  111.                 $x = $listField->getSerializer()->encode($listField, $existence, $kvPair, $nestedParameters);
  112.                 $_x = iterator_to_array($x);
  113.             } catch (WriteFieldException $exception) {
  114.                 $parameters->getContext()->getExceptions()->add($exception);
  115.             }
  116.         }
  117.     }
  118. }