vendor/shopware/core/Framework/DataAbstractionLayer/Field/ListField.php line 59

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Framework\DataAbstractionLayer\Field;
  5. use Shopware\Core\Framework\DataAbstractionLayer\FieldSerializer\ListFieldSerializer;
  6. use Shopware\Core\Framework\Feature;
  7. use Shopware\Core\Framework\Log\Package;
  9. /**
  10. * Stores a JSON formatted value list. This can be typed using the third constructor parameter.
  11. *
  12. * Definition example:
  13. *
  14. * // allow every type
  15. * new ListField('product_ids', 'productIds');
  16. *
  17. * // allow int types only
  18. * new ListField('product_ids', 'productIds', IntField::class);
  19. *
  20. * Output in database:
  21. *
  22. * // mixed type value
  23. * ['this is a string', 'another string', true, 15]
  24. *
  25. * // single type values
  26. * [12,55,192,22]
  27. */
  28. #[Package('core')]
  29. class ListField extends JsonField
  30. {
  31. /**
  32. * @var string|null
  33. */
  34. private $fieldType;
  36. /**
  37. * @deprecated tag:v6.5.0 Property strict will be removed
  38. *
  39. * @var bool
  40. */
  41. private $strict = false;
  43. public function __construct(string $storageName, string $propertyName, ?string $fieldType = null)
  44. {
  45. parent::__construct($storageName, $propertyName);
  46. $this->fieldType = $fieldType;
  47. }
  49. public function getFieldType(): ?string
  50. {
  51. return $this->fieldType;
  52. }
  54. /**
  55. * Strict `ListField` does not support keys and will strip them on decode. Use `JsonField` instead.
  56. *
  57. * @deprecated tag:v6.5.0 - will be removed
  58. */
  59. public function isStrict(): bool
  60. {
  61. if (!$this->strict) {
  62. Feature::triggerDeprecationOrThrow(
  63. 'v6.5.0.0',
  64. Feature::deprecatedMethodMessage(__CLASS__, __METHOD__, 'v6.5.0.0', 'JsonField')
  65. );
  66. }
  68. return $this->strict;
  69. }
  71. /**
  72. * Enable strict mode which forces the decode to return non-associative array. (json_encode will encode it as an array instead of an object)
  73. *
  74. * @deprecated tag:v6.5.0 - will be removed
  75. */
  76. public function setStrict(bool $strict): ListField
  77. {
  78. if (!$strict) {
  79. Feature::triggerDeprecationOrThrow(
  80. 'v6.5.0.0',
  81. Feature::deprecatedMethodMessage(__CLASS__, __METHOD__, 'v6.5.0.0', 'JsonField')
  82. );
  83. }
  85. $this->strict = $strict;
  87. return $this;
  88. }
  90. protected function getSerializerClass(): string
  91. {
  92. return ListFieldSerializer::class;
  93. }
  94. }