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

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