0 follower

Trait Yiisoft\Db\Schema\Data\LazyArrayTrait

Implemented byYiisoft\Db\Schema\Data\AbstractLazyArray, Yiisoft\Db\Schema\Data\AbstractStructuredLazyArray, Yiisoft\Db\Schema\Data\JsonLazyArray, Yiisoft\Db\Schema\Data\LazyArray, Yiisoft\Db\Schema\Data\StructuredLazyArray

Provides a common implementation for {@see AbstractLazyArray}, {@see AbstractStructuredLazyArray} and {@see JsonLazyArray}.

Public Methods

Hide inherited methods

Method Description Defined By
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
prepareValue() Prepares the value to be used as an array or throws an exception if it's impossible. Yiisoft\Db\Schema\Data\LazyArrayTrait

Method Details

Hide inherited methods

count() public method

public integer count ( )

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

            
getIterator() public method

public ArrayIterator getIterator ( )

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

            
getRawValue() public method

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

Returns parsed and typecasted value.

public array getValue ( )

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

            
jsonSerialize() public method

public array jsonSerialize ( )

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

            
offsetExists() public method

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

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

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

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() public method

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

public void prepareValue ( )
return void