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

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 Shopware\Core\Framework\Log\Package;
  16. use Symfony\Component\Validator\Constraints\Type;
  17. use Symfony\Component\Validator\Validator\ValidatorInterface;
  19. /**
  20. * @deprecated tag:v6.5.0 - reason:becomes-internal - Will be internal
  21. */
  22. #[Package('core')]
  23. class ListFieldSerializer extends AbstractFieldSerializer
  24. {
  25. /**
  26. * @internal
  27. */
  28. public function __construct(
  29. ValidatorInterface $validator,
  30. DefinitionInstanceRegistry $definitionRegistry
  31. ) {
  32. parent::__construct($validator, $definitionRegistry);
  33. }
  35. /**
  36. * @throws InvalidSerializerFieldException
  37. */
  38. public function encode(
  39. Field $field,
  40. EntityExistence $existence,
  41. KeyValuePair $data,
  42. WriteParameterBag $parameters
  43. ): \Generator {
  44. if (!$field instanceof ListField) {
  45. throw new InvalidSerializerFieldException(ListField::class, $field);
  46. }
  48. $this->validateIfNeeded($field, $existence, $data, $parameters);
  50. $value = $data->getValue();
  52. if ($value !== null) {
  53. $value = array_values($value);
  55. $this->validateTypes($field, $value, $parameters);
  57. $value = JsonFieldSerializer::encodeJson($value);
  58. }
  60. yield $field->getStorageName() => $value;
  61. }
  63. /**
  64. * @return array|null
  65. *
  66. * @deprecated tag:v6.5.0 - reason:return-type-change - The return type will be native typed
  67. */
  68. public function decode(Field $field, $value)/* ?array*/
  69. {
  70. if ($value === null) {
  71. return null;
  72. }
  74. /** @deprecated tag:v6.5.0 - remove whole is block as the `strict` behaviour will always be used */
  75. if (!Feature::isActive('v6.5.0.0')) {
  76. if ($field instanceof ListField && $field->isStrict()) {
  77. return array_values(json_decode($value, true));
  78. }
  80. return json_decode($value, true);
  81. }
  83. return array_values(json_decode($value, true));
  84. }
  86. protected function getConstraints(Field $field): array
  87. {
  88. return [new Type('array')];
  89. }
  91. protected function validateTypes(ListField $field, array $values, WriteParameterBag $parameters): void
  92. {
  93. $fieldType = $field->getFieldType();
  94. if ($fieldType === null) {
  95. return;
  96. }
  98. $existence = new EntityExistence(null, [], false, false, false, []);
  100. /** @var Field $listField */
  101. $listField = new $fieldType('key', 'key');
  102. $listField->compile($this->definitionRegistry);
  104. $nestedParameters = $parameters->cloneForSubresource(
  105. $parameters->getDefinition(),
  106. $parameters->getPath() . '/' . $field->getPropertyName()
  107. );
  109. foreach ($values as $i => $value) {
  110. try {
  111. $kvPair = new KeyValuePair((string) $i, $value, true);
  113. $x = $listField->getSerializer()->encode($listField, $existence, $kvPair, $nestedParameters);
  114. $_x = iterator_to_array($x);
  115. } catch (WriteFieldException $exception) {
  116. $parameters->getContext()->getExceptions()->add($exception);
  117. }
  118. }
  119. }
  120. }