0 follower

Final Class Yiisoft\Db\Expression\Value\StructuredValue

All Classes | Properties | Methods
InheritanceYiisoft\Db\Expression\Value\StructuredValue
ImplementsYiisoft\Db\Expression\ExpressionInterface

Represents a structured type SQL expression.

See also https://en.wikipedia.org/wiki/Structured_type For example: `php new StructuredValue(['price' => 10, 'currency_code' => 'USD']); ` Will be encoded to ROW(10, USD) in PostgreSQL.

Public Properties

Hide inherited properties

Property Type Description Defined By
$type Yiisoft\Db\Schema\Column\AbstractStructuredColumn|string|null Yiisoft\Db\Expression\Value\StructuredValue
$value array|object|string|null Yiisoft\Db\Expression\Value\StructuredValue

Public Methods

Hide inherited methods

Method Description Defined By
__construct() Yiisoft\Db\Expression\Value\StructuredValue

Property Details

Hide inherited properties

$value public property
public array|object|string|null $value = null

Method Details

Hide inherited methods

__construct() public method

public mixed __construct ( array|object|string|null $value, Yiisoft\Db\Schema\Column\AbstractStructuredColumn|string|null $type = null )
$value array|object|string|null

The content of the structured type which can be represented as

  • an associative array of column names and values;
  • an indexed array of column values in the order of structured type columns;
  • an {@see \JsonSerializable} object that can be converted to an array using jsonSerialize();
  • an iterable object that can be converted to an array using iterator_to_array();
  • an object that can be converted to an array using get_object_vars();
  • an {@see \Yiisoft\Db\Query\QueryInterface} object that represents a SQL sub-query;
  • a string retrieved value from the database that can be parsed into an array;
  • null.
$type Yiisoft\Db\Schema\Column\AbstractStructuredColumn|string|null

The structured column type which can be represented as

  • a native database column type suitable to store the {@see \Yiisoft\Db\Expression\Value\value};
  • an instance of {@see \Yiisoft\Db\Schema\Column\AbstractStructuredColumn};
  • null if the type isn't explicitly specified.

The column type is used to typecast structured values before saving into the database and for adding type hint to the SQL statement. If the type isn't specified and DBMS can't guess it from the context, SQL error will be raised.

 

                public function __construct(
    public readonly array|object|string|null $value,
    public readonly AbstractStructuredColumn|string|null $type = null,
) {}