InConditionBuilder

API reference › yii › db › conditions › InConditionBuilder

class	`yii\db\conditions\InConditionBuilder`
Implements	`yii\db\ExpressionBuilderInterface`
Uses traits	`yii\db\ExpressionBuilderTrait`
Since	2.0.14
Source	`framework/db/conditions/InConditionBuilder.php`

3 subclasses

Builds objects of InCondition.

Properties

Property	Type	Description	Defined by
`$queryBuilder` protected	`yii\db\QueryBuilder`	Default: `null`.	`yii\db\ExpressionBuilderTrait`

Methods

Method	Description	Defined by
`__construct()`	ExpressionBuilderTrait constructor.	`yii\db\ExpressionBuilderTrait`
`build()`	Builds raw SQL from the expression.	`InConditionBuilder`
`buildCompositeInCondition()` protected	Builds SQL for composite IN condition.	`InConditionBuilder`
`buildSubqueryInCondition()` protected	Builds SQL for IN condition.	`InConditionBuilder`
`buildValues()` protected	Builds values to be used in `InCondition`.	`InConditionBuilder`
`getNotEqualOperator()` protected	Returns inequality operator for decomposed `NOT IN` conditions.	`InConditionBuilder`
`getNullCondition()` protected	Builds `IS NULL` / `IS NOT NULL` condition for a scalar column based on the operator.	`InConditionBuilder`

Method details

build()

public function build(yii\db\ExpressionInterface|yii\db\conditions\InCondition $expression, array &$params = []): string

Builds raw SQL from the expression.

Parameters

Parameter	Type	Description
`$expression`	`yii\db\ExpressionInterface\|InCondition`	The expression to be built.
`$params`	`array`	The binding parameters.

Returns

string: The raw SQL that will not be additionally escaped or quoted.

buildCompositeInCondition()

protected function buildCompositeInCondition(string $operator, array $columns, array $values, array &$params): string

Builds SQL for composite IN condition.

Parameters

Parameter	Type	Description
`$operator`	`string`	Operator in uppercase.
`$columns`	`array`	Columns to be matched.
`$values`	`array`	Row values.
`$params`	`array`	The binding parameters.

Returns

string: SQL for composite IN condition.

buildSubqueryInCondition()

protected function buildSubqueryInCondition(string $operator, array|string|yii\db\ExpressionInterface $columns, yii\db\Query $values, array &$params): string

Builds SQL for IN condition.

Parameters

Parameter	Type	Description
`$operator`	`string`	Operator in uppercase.
`$columns`	`array\|string\|yii\db\ExpressionInterface`	The columns to be matched.
`$values`	`yii\db\Query`	Subquery values.
`$params`	`array`	The binding parameters.

Returns

string: SQL for IN condition.

buildValues()

protected function buildValues(yii\db\conditions\ConditionInterface|yii\db\conditions\InCondition $condition, array $values, array &$params): array

Builds values to be used in InCondition.

Parameters

Parameter	Type	Description
`$condition`	`ConditionInterface\|InCondition`	The condition to be built.
`$values`	`array`	The values to bind.
`$params`	`array`	The binding parameters.

Returns

array: Prepared SQL placeholders.

getNotEqualOperator()

protected function getNotEqualOperator(): string

Returns inequality operator for decomposed NOT IN conditions.

Returns

string: Inequality operator.

getNullCondition()

protected function getNullCondition(string $operator, string $column): string

Builds IS NULL / IS NOT NULL condition for a scalar column based on the operator.

Parameters

Parameter	Type	Description
`$operator`	`string`	Operator in uppercase.
`$column`	`string`	Column to be matched.

Returns

string: Null condition SQL.

Since

2.0.31