0 follower

Final Class Yiisoft\Db\Schema\Data\JsonLazyArray

All Classes | Properties | Methods
InheritanceYiisoft\Db\Schema\Data\JsonLazyArray
ImplementsArrayAccess, Countable, IteratorAggregate, JsonSerializable, Yiisoft\Db\Schema\Data\LazyArrayInterface
Uses TraitsYiisoft\Db\Schema\Data\LazyArrayTrait

Represents a JSON array value retrieved from the database.

Initially, the value is a string that parsed into an array when it's accessed as an array or iterated over.

Protected Properties

Hide inherited properties

Property Type Description Defined By
$value array|string Yiisoft\Db\Schema\Data\JsonLazyArray

Public Methods

Hide inherited methods

Method Description Defined By
__construct() Yiisoft\Db\Schema\Data\JsonLazyArray
count() Yiisoft\Db\Schema\Data\LazyArrayTrait
getIterator() Yiisoft\Db\Schema\Data\LazyArrayTrait
getRawValue() The raw value that can be represented as: - a string retrieved value from the database that can be parsed into an array; - an array of values if the value is already parsed. Yiisoft\Db\Schema\Data\LazyArrayTrait
getValue() Returns parsed and typecasted value. Yiisoft\Db\Schema\Data\LazyArrayTrait
jsonSerialize() Yiisoft\Db\Schema\Data\LazyArrayTrait
offsetExists() Yiisoft\Db\Schema\Data\LazyArrayTrait
offsetGet() Yiisoft\Db\Schema\Data\LazyArrayTrait
offsetSet() Yiisoft\Db\Schema\Data\LazyArrayTrait
offsetUnset() Yiisoft\Db\Schema\Data\LazyArrayTrait

Protected Methods

Hide inherited methods

Method Description Defined By
prepareValue() Prepares the value to be used as an array or throws an exception if it's impossible. Yiisoft\Db\Schema\Data\JsonLazyArray

Property Details

Hide inherited properties

$value protected property
protected array|string $value = null

Method Details

Hide inherited methods

__construct() public method

public mixed __construct ( string $value )
$value string

The string retrieved value from the database that can be parsed into an array.

 

                public function __construct(
    string $value,
) {
    $this->value = $value;
}
count() public method

Defined in: Yiisoft\Db\Schema\Data\LazyArrayTrait::count()

public integer count ( )

                public function count(): int
{
    $this->prepareValue();
    return count($this->value);
}
getIterator() public method

Defined in: Yiisoft\Db\Schema\Data\LazyArrayTrait::getIterator()

public ArrayIterator getIterator ( )

                public function getIterator(): ArrayIterator
{
    $this->prepareValue();
    return new ArrayIterator($this->value);
}
getRawValue() public method

Defined in: Yiisoft\Db\Schema\Data\LazyArrayTrait::getRawValue()

The raw value that can be represented as: - a string retrieved value from the database that can be parsed into an array; - an array of values if the value is already parsed.

public array|string getRawValue ( )

                public function getRawValue(): array|string
{
    return $this->value;
}
getValue() public method

Defined in: Yiisoft\Db\Schema\Data\LazyArrayTrait::getValue()

Returns parsed and typecasted value.

public array getValue ( )

                public function getValue(): array
{
    $this->prepareValue();
    return $this->value;
}
jsonSerialize() public method

Defined in: Yiisoft\Db\Schema\Data\LazyArrayTrait::jsonSerialize()

public array jsonSerialize ( )

                public function jsonSerialize(): array
{
    return $this->getValue();
}
offsetExists() public method

Defined in: Yiisoft\Db\Schema\Data\LazyArrayTrait::offsetExists()

public boolean offsetExists ( integer|string $offset )
$offset integer|string

The offset to check.

 

                public function offsetExists(mixed $offset): bool
{
    $this->prepareValue();
    return isset($this->value[$offset]);
}
offsetGet() public method

Defined in: Yiisoft\Db\Schema\Data\LazyArrayTrait::offsetGet()

public mixed offsetGet ( integer|string $offset )
$offset integer|string

The offset to retrieve.

 

                public function offsetGet(mixed $offset): mixed
{
    $this->prepareValue();
    return $this->value[$offset];
}
offsetSet() public method

Defined in: Yiisoft\Db\Schema\Data\LazyArrayTrait::offsetSet()

public void offsetSet ( integer|string $offset, mixed $value )
$offset integer|string

The offset to assign the value to.
$value mixed 

                public function offsetSet(mixed $offset, mixed $value): void
{
    $this->prepareValue();
    $this->value[$offset] = $value;
}
offsetUnset() public method

Defined in: Yiisoft\Db\Schema\Data\LazyArrayTrait::offsetUnset()

public void offsetUnset ( integer|string $offset )
$offset integer|string

The offset to unset.

 

                public function offsetUnset(mixed $offset): void
{
    $this->prepareValue();
    unset($this->value[$offset]);
}
prepareValue() protected method

Prepares the value to be used as an array or throws an exception if it's impossible.

protected void prepareValue ( )

                protected function prepareValue(): void
{
    if (is_string($this->value)) {
        $value = json_decode($this->value, true, 512, JSON_THROW_ON_ERROR);
        if (!is_array($value)) {
            throw new InvalidArgumentException('JSON value must be a valid string array representation.');
        }
        $this->value = $value;
    }
}