InCondition

API reference › yii › db › conditions › InCondition

class	`yii\db\conditions\InCondition`
Implements	`ConditionInterface`
Since	2.0.14
Source	`framework/db/conditions/InCondition.php`

Represents IN condition.

Methods

Method	Description	Defined by
`__construct()`		`InCondition`
`fromArrayDefinition()` static	Creates object by array-definition as described in Query Builder – Operator format guide article.	`InCondition`
`getColumn()`	Returns the column(s) being matched.	`InCondition`
`getOperator()`	Returns the comparison operator.	`InCondition`
`getValues()`	Returns the value(s) to match against.	`InCondition`

Method details

__construct()

public function __construct(array|string|yii\db\ExpressionInterface|Traversable $column, string $operator, array|int|string|yii\db\ExpressionInterface|Traversable $values)

Parameters

Parameter	Type	Description
`$column`	`array\|string\|yii\db\ExpressionInterface\|Traversable`	The column name. If it is an array, a composite `IN` condition will be generated.
`$operator`	`string`	The operator to use (e.g. `IN` or `NOT IN`).
`$values`	`array\|int\|string\|yii\db\ExpressionInterface\|Traversable`	An array of values that `column` value should be among. If it is an empty array the generated expression will be a `false` value if `operator` is `IN` and empty if operator is `NOT IN`.

fromArrayDefinition()

public static function fromArrayDefinition(mixed $operator, mixed $operands): static

Creates object by array-definition as described in Query Builder – Operator format guide article.

Parameters

Parameter	Type	Description
`$operator`	`mixed`	Operator in uppercase.
`$operands`	`mixed`	Array of corresponding operands

Returns

static

Throws

yii\base\InvalidArgumentException: if wrong number of operands have been given.

getColumn()

public function getColumn(): array|string|yii\db\ExpressionInterface

Returns the column(s) being matched.

Normalizes Traversable input to an array on first access and caches the result for subsequent calls.

Returns

array|string|yii\db\ExpressionInterface: Column name, list of column names for composite conditions, or an expression.

getOperator()

public function getOperator(): string

Returns the comparison operator.

Returns

string: Operator (for example, IN or NOT IN).

getValues()

public function getValues(): array|int|string|yii\db\ExpressionInterface

Returns the value(s) to match against.

Normalizes Traversable input to an array on first access and caches the result for subsequent calls.

Returns

array|int|string|yii\db\ExpressionInterface: Value list, scalar, or expression used for the comparison.