# Class yii\db\conditions\InConditionBuilder

Inheritance | yii\db\conditions\InConditionBuilder
Implements | yii\db\ExpressionBuilderInterface
Uses Traits | yii\db\ExpressionBuilderTrait
Subclasses | yii\db\mssql\conditions\InConditionBuilder, yii\db\oci\conditions\InConditionBuilder, yii\db\sqlite\conditions\InConditionBuilder
Available since version | 2.0.14
Source Code | https://github.com/yiisoft/yii2/blob/master/framework/db/conditions/InConditionBuilder.php

Class InConditionBuilder builds objects of yii\db\conditions\InCondition

## Protected Properties

Hide inherited properties

Property | Type | Description | Defined By
--- | --- | --- | ---

## Public Methods

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
__construct() | ExpressionBuilderTrait constructor. | yii\db\ExpressionBuilderTrait
build() | Method builds the raw SQL from the $expression that will not be additionally escaped or quoted. | yii\db\conditions\InConditionBuilder

## Protected Methods

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
buildCompositeInCondition() | Builds SQL for IN condition. | yii\db\conditions\InConditionBuilder
buildSubqueryInCondition() | Builds SQL for IN condition. | yii\db\conditions\InConditionBuilder
buildValues() | Builds $values to be used in yii\db\conditions\InCondition | yii\db\conditions\InConditionBuilder
getNullCondition() | Builds is null/is not null condition for column based on operator | yii\db\conditions\InConditionBuilder
getRawValuesFromTraversableObject() |  | yii\db\conditions\InConditionBuilder

## Method Details

Hide inherited methods

__construct() public method

Defined in: yii\db\ExpressionBuilderTrait::__construct()

ExpressionBuilderTrait constructor.

public void __construct ( yii\db\QueryBuilder $queryBuilder )
$queryBuilder | yii\db\QueryBuilder |

Source code

                    public function __construct(QueryBuilder $queryBuilder)
    {
        $this->queryBuilder = $queryBuilder;
    }

build() public method

Method builds the raw SQL from the $expression that will not be additionally escaped or quoted.

public string build ( yii\db\ExpressionInterface $expression, array &$params = [] )
$expression | yii\db\ExpressionInterface|yii\db\conditions\InCondition | The expression to be built.
$params | array | The binding parameters.
return | string | The raw SQL that will not be additionally escaped or quoted.

Source code

                    public function build(ExpressionInterface $expression, array &$params = [])
    {
        $operator = strtoupper($expression->getOperator());
        $column = $expression->getColumn();
        $values = $expression->getValues();
        if ($column === []) {
            // no columns to test against
            return $operator === 'IN' ? '0=1' : '';
        }
        if ($values instanceof Query) {
            return $this->buildSubqueryInCondition($operator, $column, $values, $params);
        }
        if (!is_array($values) && !$values instanceof \Traversable) {
            // ensure values is an array
            $values = (array) $values;
        }
        if (is_array($column)) {
            if (count($column) > 1) {
                return $this->buildCompositeInCondition($operator, $column, $values, $params);
            }
            $column = reset($column);
        }
        if ($column instanceof \Traversable) {
            if (iterator_count($column) > 1) {
                return $this->buildCompositeInCondition($operator, $column, $values, $params);
            }
            $column->rewind();
            $column = $column->current();
        }
        if ($column instanceof Expression) {
            $column = $column->expression;
        }
        if (is_array($values)) {
            $rawValues = $values;
        } elseif ($values instanceof \Traversable) {
            $rawValues = $this->getRawValuesFromTraversableObject($values);
        }
        $nullCondition = null;
        $nullConditionOperator = null;
        if (isset($rawValues) && in_array(null, $rawValues, true)) {
            $nullCondition = $this->getNullCondition($operator, $column);
            $nullConditionOperator = $operator === 'IN' ? 'OR' : 'AND';
        }
        $sqlValues = $this->buildValues($expression, $values, $params);
        if (empty($sqlValues)) {
            if ($nullCondition === null) {
                return $operator === 'IN' ? '0=1' : '';
            }
            return $nullCondition;
        }
        if (strpos($column, '(') === false) {
            $column = $this->queryBuilder->db->quoteColumnName($column);
        }
        if (count($sqlValues) > 1) {
            $sql = "$column $operator (" . implode(', ', $sqlValues) . ')';
        } else {
            $operator = $operator === 'IN' ? '=' : '<>';
            $sql = $column . $operator . reset($sqlValues);
        }
        return $nullCondition !== null && $nullConditionOperator !== null
            ? sprintf('%s %s %s', $sql, $nullConditionOperator, $nullCondition)
            : $sql;
    }

buildCompositeInCondition() protected method

Builds SQL for IN condition.

protected string buildCompositeInCondition ( $operator, $columns, $values, &$params )
$operator | string |
$columns | array|Traversable |
$values | array |
$params | array |
return | string | SQL

Source code

                    protected function buildCompositeInCondition($operator, $columns, $values, &$params)
    {
        $vss = [];
        foreach ($values as $value) {
            $vs = [];
            foreach ($columns as $column) {
                if ($column instanceof Expression) {
                    $column = $column->expression;
                }
                if (isset($value[$column])) {
                    $vs[] = $this->queryBuilder->bindParam($value[$column], $params);
                } else {
                    $vs[] = 'NULL';
                }
            }
            $vss[] = '(' . implode(', ', $vs) . ')';
        }
        if (empty($vss)) {
            return $operator === 'IN' ? '0=1' : '';
        }
        $sqlColumns = [];
        foreach ($columns as $i => $column) {
            if ($column instanceof Expression) {
                $column = $column->expression;
            }
            $sqlColumns[] = strpos($column, '(') === false ? $this->queryBuilder->db->quoteColumnName($column) : $column;
        }
        return '(' . implode(', ', $sqlColumns) . ") $operator (" . implode(', ', $vss) . ')';
    }

buildSubqueryInCondition() protected method

Builds SQL for IN condition.

protected string buildSubqueryInCondition ( $operator, $columns, $values, &$params )
$operator | string |
$columns | array|string |
$values | yii\db\Query |
$params | array |
return | string | SQL

Source code

                    protected function buildSubqueryInCondition($operator, $columns, $values, &$params)
    {
        $sql = $this->queryBuilder->buildExpression($values, $params);
        if (is_array($columns)) {
            foreach ($columns as $i => $col) {
                if ($col instanceof Expression) {
                    $col = $col->expression;
                }
                if (strpos($col, '(') === false) {
                    $columns[$i] = $this->queryBuilder->db->quoteColumnName($col);
                }
            }
            return '(' . implode(', ', $columns) . ") $operator $sql";
        }
        if ($columns instanceof Expression) {
            $columns = $columns->expression;
        }
        if (strpos($columns, '(') === false) {
            $columns = $this->queryBuilder->db->quoteColumnName($columns);
        }
        return "$columns $operator $sql";
    }

buildValues() protected method

Builds $values to be used in yii\db\conditions\InCondition

protected array buildValues ( yii\db\conditions\ConditionInterface $condition, $values, &$params )
$condition | yii\db\conditions\ConditionInterface|yii\db\conditions\InCondition |
$values | array |
$params | array | The binding parameters
return | array | Of prepared for SQL placeholders

Source code

                    protected function buildValues(ConditionInterface $condition, $values, &$params)
    {
        $sqlValues = [];
        $column = $condition->getColumn();
        if (is_array($column)) {
            $column = reset($column);
        }
        if ($column instanceof \Traversable) {
            $column->rewind();
            $column = $column->current();
        }
        if ($column instanceof Expression) {
            $column = $column->expression;
        }
        foreach ($values as $i => $value) {
            if (is_array($value) || $value instanceof \ArrayAccess) {
                $value = isset($value[$column]) ? $value[$column] : null;
            }
            if ($value === null) {
                continue;
            } elseif ($value instanceof ExpressionInterface) {
                $sqlValues[$i] = $this->queryBuilder->buildExpression($value, $params);
            } else {
                $sqlValues[$i] = $this->queryBuilder->bindParam($value, $params);
            }
        }
        return $sqlValues;
    }

getNullCondition() protected method (available since version 2.0.31)

Builds is null/is not null condition for column based on operator

protected string getNullCondition ( $operator, $column )
$operator | string |
$column | string |
return | string | Is null or is not null condition

Source code

                    protected function getNullCondition($operator, $column)
    {
        $column = $this->queryBuilder->db->quoteColumnName($column);
        if ($operator === 'IN') {
            return sprintf('%s IS NULL', $column);
        }
        return sprintf('%s IS NOT NULL', $column);
    }

getRawValuesFromTraversableObject() protected method (available since version 2.0.31)

protected array getRawValuesFromTraversableObject ( Traversable $traversableObject )
$traversableObject | Traversable |
return | array | Raw values

Source code

                    protected function getRawValuesFromTraversableObject(\Traversable $traversableObject)
    {
        $rawValues = [];
        foreach ($traversableObject as $value) {
            if (is_array($value)) {
                $values = array_values($value);
                $rawValues = array_merge($rawValues, $values);
            } else {
                $rawValues[] = $value;
            }
        }
        return $rawValues;
    }