RetroSearch Browse

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://www.yiiframework.com/doc/api/2.0/yii-db-arrayexpression below:

ArrayExpression, yii\db\ArrayExpression | API Documentation for Yii 2.0

Class yii\db\ArrayExpression

Class ArrayExpression represents an array SQL expression.

Expressions of this type can be used in conditions as well:

$query->andWhere(['@>', 'items', new ArrayExpression([1, 2, 3], 'integer')])

which, depending on DBMS, will result in a well-prepared condition. For example, in PostgreSQL it will be compiled to WHERE "items" @> ARRAY[1, 2, 3]::integer[].

Method Details

Hide inherited methods

ArrayExpression constructor.

public void __construct ( $value, $type = null, $dimension = 1 ) $value array|yii\db\QueryInterface|mixed

The array content. Either represented as an array of values or a Query that returns these values. A single value will be considered as an array containing one element.

$type string|null

The type of the array elements. Defaults to null which means the type is not explicitly specified. In case when type is not specified explicitly and DBMS can not guess it from the context, SQL error will be raised.

$dimension integer

The number of indices needed to select an element

Source code

                public function __construct($value, $type = null, $dimension = 1)
{
    if ($value instanceof self) {
        $value = $value->getValue();
    }
    $this->value = $value;
    $this->type = $type;
    $this->dimension = $dimension;
}

Count elements of an object

public integer count ( ) return integer

The custom count as an integer.

The return value is cast to an integer.

Source code

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

Source code

                public function getDimension()
{
    return $this->dimension;
}

Retrieve an external iterator

Source code

                
public function getIterator()
{
    $value = $this->getValue();
    if ($value instanceof QueryInterface) {
        throw new InvalidConfigException('The ArrayExpression class can not be iterated when the value is a QueryInterface object');
    }
    if ($value === null) {
        $value = [];
    }
    return new \ArrayIterator($value);
}

Source code

                public function getType()
{
    return $this->type;
}

Source code

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

Whether a offset exists

public boolean offsetExists ( $offset ) $offset mixed

An offset to check for.

return boolean

True on success or false on failure.

The return value will be casted to boolean if non-boolean was returned.

Source code

                
public function offsetExists($offset)
{
    return isset($this->value[$offset]);
}

Offset to retrieve

public mixed offsetGet ( $offset ) $offset mixed

The offset to retrieve.

return mixed

Can return all value types.

Source code

                
public function offsetGet($offset)
{
    return $this->value[$offset];
}

Offset to set

public void offsetSet ( $offset, $value ) $offset mixed

The offset to assign the value to.

$value mixed

The value to set.

Source code

                
public function offsetSet($offset, $value)
{
    $this->value[$offset] = $value;
}

Offset to unset

public void offsetUnset ( $offset ) $offset mixed

The offset to unset.

Source code

                
public function offsetUnset($offset)
{
    unset($this->value[$offset]);
}

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4