Class yii\db\ArrayExpression

所有类 | 方法

继承	yii\db\ArrayExpression
实现	ArrayAccess, Countable, IteratorAggregate, yii\db\ExpressionInterface
可用版本自	2.0.14
源码	https://github.com/yiichina/yii2/blob/api/framework/db/ArrayExpression.php

ArrayExpression 类表示数组的 SQL 表达式。

此类表达式也可以用于以下条件：

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

这取决于 DBMS，将实现良好的准备条件。例如，在 PostgreSQL 中，它将被编译为 WHERE "items" @> ARRAY[1, 2, 3]::integer[]。

公共方法

__construct() 公共方法

ArrayExpression 构造函数。

public void __construct($value, $type = null, $dimension = 1)
$value	array\|yii\db\QueryInterface\|mixed	数组内容。表示为值数组或返回这些值的 Query。单个值将被视为包含一个元素的数组。
$type	string\|null	数组元素的类型。默认为 `null`，表示未明确指定类型。如果未明确指定 type 并且 DBMS 无法从上下文中猜出它，则会引起 SQL 错误。
$dimension	integer	选择元素所需的索引数

count() 公共方法（自版本 2.0.14 可用）

计算对象的元素

public integer count()
return	integer	自定义计数为整数。返回值转换为整数。

getDimension() 公共方法

参见 \yii\db\dimensions.

public integer getDimension()
return	integer	选择元素所需的索引数

getIterator() 公共方法（自版本 2.0.14.1 可用）

检索外部迭代器

public Traversable getIterator()
return	Traversable	实现迭代器或可遍历的对象实例
throws	yii\base\InvalidConfigException	当 ArrayExpression 包含 QueryInterface 对象时

getType() 公共方法

参见 \yii\db\type.

public null\|string getType()

getValue() 公共方法

参见 \yii\db\value.

public array\|mixed\|yii\db\QueryInterface getValue()

offsetExists() 公共方法（自版本 2.0.14 可用）

是否存在偏移量

public boolean offsetExists($offset)
$offset	mixed	要检查的偏移量。
return	boolean	成功时为 true，失败为 false。如果返回非布尔值，则返回值将被转换为 boolean。

offsetGet() 公共方法（自版本 2.0.14 可用）

要检索的偏移量

public mixed offsetGet($offset)
$offset	mixed	要检索的偏移量。
return	mixed	可以返回所有值类型。

offsetSet() 公共方法（自版本 2.0.14 可用）

偏移量设置

public void offsetSet($offset, $value)
$offset	mixed	要赋值的偏移量。
$value	mixed	要设置的值。

offsetUnset() 公共方法（自版本 2.0.14 可用）

删除偏移量

public void offsetUnset($offset)
$offset	mixed	要删除的偏移量。