Passed
Push — upd ( 4ab535...960949 )
by Paweł
26:01 queued 21:45
created

InConditionBuilder::build()   F

Complexity

Conditions 24
Paths 3897

Size

Total Lines 73
Code Lines 44

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 24
eloc 44
nc 3897
nop 2
dl 0
loc 73
rs 0
c 0
b 0
f 0

How to fix   Long Method    Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
2
/**
3
 * @link http://www.yiiframework.com/
4
 * @copyright Copyright (c) 2008 Yii Software LLC
5
 * @license http://www.yiiframework.com/license/
6
 */
7
8
namespace yii\db\conditions;
9
10
use yii\db\ExpressionBuilderInterface;
11
use yii\db\ExpressionBuilderTrait;
12
use yii\db\ExpressionInterface;
13
use yii\db\Query;
14
15
/**
16
 * Class InConditionBuilder builds objects of [[InCondition]]
17
 *
18
 * @author Dmytro Naumenko <[email protected]>
19
 * @since 2.0.14
20
 */
21
class InConditionBuilder implements ExpressionBuilderInterface
22
{
23
    use ExpressionBuilderTrait;
24
25
26
    /**
27
     * Method builds the raw SQL from the $expression that will not be additionally
28
     * escaped or quoted.
29
     *
30
     * @param ExpressionInterface|InCondition $expression the expression to be built.
31
     * @param array $params the binding parameters.
32
     * @return string the raw SQL that will not be additionally escaped or quoted.
33
     */
34
    public function build(ExpressionInterface $expression, array &$params = [])
35
    {
36
        $operator = strtoupper($expression->getOperator());
0 ignored issues
show
Bug introduced by
The method getOperator() does not exist on yii\db\ExpressionInterface. It seems like you code against a sub-type of said class. However, the method does not exist in yii\db\JsonExpression or yii\db\ArrayExpression or yii\db\PdoValue or yii\db\conditions\ConditionInterface or yii\db\conditions\HashCondition or yii\db\conditions\NotCondition. Are you sure you never get one of those? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

36
        $operator = strtoupper($expression->/** @scrutinizer ignore-call */ getOperator());
Loading history...
37
        $column = $expression->getColumn();
0 ignored issues
show
Bug introduced by
The method getColumn() does not exist on yii\db\ExpressionInterface. It seems like you code against a sub-type of yii\db\ExpressionInterface such as yii\db\Query or yii\db\Expression or yii\db\conditions\InCondition or yii\db\conditions\BetweenCondition or yii\db\conditions\SimpleCondition. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

37
        /** @scrutinizer ignore-call */ 
38
        $column = $expression->getColumn();
Loading history...
38
        $values = $expression->getValues();
0 ignored issues
show
Bug introduced by
The method getValues() does not exist on yii\db\ExpressionInterface. It seems like you code against a sub-type of yii\db\ExpressionInterface such as yii\db\Query or yii\db\Expression or yii\db\conditions\InCondition. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

38
        /** @scrutinizer ignore-call */ 
39
        $values = $expression->getValues();
Loading history...
39
40
        if ($column === []) {
41
            // no columns to test against
42
            return $operator === 'IN' ? '0=1' : '';
43
        }
44
45
        if ($values instanceof Query) {
46
            return $this->buildSubqueryInCondition($operator, $column, $values, $params);
47
        }
48
49
        if (!is_array($values) && !$values instanceof \Traversable) {
50
            // ensure values is an array
51
            $values = (array) $values;
52
        }
53
54
        if (is_array($column)) {
55
            if (count($column) > 1) {
56
                return $this->buildCompositeInCondition($operator, $column, $values, $params);
0 ignored issues
show
Bug introduced by
It seems like $values can also be of type Traversable; however, parameter $values of yii\db\conditions\InCond...dCompositeInCondition() does only seem to accept array, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

56
                return $this->buildCompositeInCondition($operator, $column, /** @scrutinizer ignore-type */ $values, $params);
Loading history...
57
            }
58
            $column = reset($column);
59
        }
60
61
        if ($column instanceof \Traversable) {
62
            if (iterator_count($column) > 1) {
63
                return $this->buildCompositeInCondition($operator, $column, $values, $params);
64
            }
65
            $column->rewind();
0 ignored issues
show
Bug introduced by
The method rewind() does not exist on Traversable. It seems like you code against a sub-type of Traversable such as Yaf_Config_Simple or Yaf\Session or SimpleXMLElement or Yaf_Session or Yaf\Config\Simple or Yaf\Config\Ini or Iterator or Yaf_Config_Ini or MongoGridFSCursor or yii\test\ArrayFixture or yii\web\HeaderCollection or SplFixedArray or yii\test\BaseActiveFixture or yii\base\Model or yii\web\CookieCollection or yii\web\Session. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

65
            $column->/** @scrutinizer ignore-call */ 
66
                     rewind();
Loading history...
66
            $column = $column->current();
0 ignored issues
show
Bug introduced by
The method current() does not exist on Traversable. It seems like you code against a sub-type of Traversable such as IntlCodePointBreakIterator or Yaf_Config_Simple or Yaf\Session or SimpleXMLElement or IntlRuleBasedBreakIterator or Yaf_Session or Yaf\Config\Simple or Yaf\Config\Ini or Iterator or Yaf_Config_Ini or MongoGridFSCursor or yii\test\ArrayFixture or yii\web\HeaderCollection or SplFixedArray or yii\test\BaseActiveFixture or yii\base\Model or yii\web\CookieCollection or IntlBreakIterator or yii\web\Session. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

66
            /** @scrutinizer ignore-call */ 
67
            $column = $column->current();
Loading history...
67
        }
68
69
        if ($column instanceof ExpressionInterface) {
70
            $column = $column->expression;
0 ignored issues
show
Bug introduced by
Accessing expression on the interface yii\db\ExpressionInterface suggest that you code against a concrete implementation. How about adding an instanceof check?
Loading history...
71
        }
72
73
        if (is_array($values)) {
74
            $rawValues = $values;
75
        } elseif ($values instanceof \Traversable) {
0 ignored issues
show
introduced by
$values is always a sub-type of Traversable.
Loading history...
76
            $rawValues = $this->getRawValuesFromTraversableObject($values);
77
        }
78
79
        $nullCondition = null;
80
        $nullConditionOperator = null;
81
        if (isset($rawValues) && in_array(null, $rawValues, true)) {
82
            $nullCondition = $this->getNullCondition($operator, $column);
83
            $nullConditionOperator = $operator === 'IN' ? 'OR' : 'AND';
84
        }
85
86
        $sqlValues = $this->buildValues($expression, $values, $params);
0 ignored issues
show
Bug introduced by
It seems like $values can also be of type Traversable; however, parameter $values of yii\db\conditions\InCond...nBuilder::buildValues() does only seem to accept array, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

86
        $sqlValues = $this->buildValues($expression, /** @scrutinizer ignore-type */ $values, $params);
Loading history...
87
        if (empty($sqlValues)) {
88
            if ($nullCondition === null) {
89
                return $operator === 'IN' ? '0=1' : '';
90
            }
91
            return $nullCondition;
92
        }
93
94
        if (strpos($column, '(') === false) {
95
            $column = $this->queryBuilder->db->quoteColumnName($column);
96
        }
97
        if (count($sqlValues) > 1) {
98
            $sql = "$column $operator (" . implode(', ', $sqlValues) . ')';
99
        } else {
100
            $operator = $operator === 'IN' ? '=' : '<>';
101
            $sql = $column . $operator . reset($sqlValues);
102
        }
103
104
        return $nullCondition !== null && $nullConditionOperator !== null
105
            ? sprintf('%s %s %s', $sql, $nullConditionOperator, $nullCondition)
106
            : $sql;
107
    }
108
109
    /**
110
     * Builds $values to be used in [[InCondition]]
111
     *
112
     * @param ConditionInterface|InCondition $condition
113
     * @param array $values
114
     * @param array $params the binding parameters
115
     * @return array of prepared for SQL placeholders
116
     */
117
    protected function buildValues(ConditionInterface $condition, $values, &$params)
118
    {
119
        $sqlValues = [];
120
        $column = $condition->getColumn();
0 ignored issues
show
Bug introduced by
The method getColumn() does not exist on yii\db\conditions\ConditionInterface. It seems like you code against a sub-type of yii\db\conditions\ConditionInterface such as yii\db\conditions\InCondition or yii\db\conditions\BetweenCondition or yii\db\conditions\SimpleCondition. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

120
        /** @scrutinizer ignore-call */ 
121
        $column = $condition->getColumn();
Loading history...
121
122
        if (is_array($column)) {
123
            $column = reset($column);
124
        }
125
126
        if ($column instanceof \Traversable) {
127
            $column->rewind();
128
            $column = $column->current();
129
        }
130
131
        if ($column instanceof ExpressionInterface) {
132
            $column = $column->expression;
0 ignored issues
show
Bug introduced by
Accessing expression on the interface yii\db\ExpressionInterface suggest that you code against a concrete implementation. How about adding an instanceof check?
Loading history...
133
        }
134
135
        foreach ($values as $i => $value) {
136
            if (is_array($value) || $value instanceof \ArrayAccess) {
137
                $value = isset($value[$column]) ? $value[$column] : null;
138
            }
139
            if ($value === null) {
140
                continue;
141
            } elseif ($value instanceof ExpressionInterface) {
142
                $sqlValues[$i] = $this->queryBuilder->buildExpression($value, $params);
143
            } else {
144
                $sqlValues[$i] = $this->queryBuilder->bindParam($value, $params);
145
            }
146
        }
147
148
        return $sqlValues;
149
    }
150
151
    /**
152
     * Builds SQL for IN condition.
153
     *
154
     * @param string $operator
155
     * @param array|string $columns
156
     * @param Query $values
157
     * @param array $params
158
     * @return string SQL
159
     */
160
    protected function buildSubqueryInCondition($operator, $columns, $values, &$params)
161
    {
162
        $sql = $this->queryBuilder->buildExpression($values, $params);
163
164
        if (is_array($columns)) {
165
            foreach ($columns as $i => $col) {
166
                if ($col instanceof ExpressionInterface) {
167
                    $col = $col->expression;
0 ignored issues
show
Bug introduced by
Accessing expression on the interface yii\db\ExpressionInterface suggest that you code against a concrete implementation. How about adding an instanceof check?
Loading history...
168
                }
169
                if (strpos($col, '(') === false) {
170
                    $columns[$i] = $this->queryBuilder->db->quoteColumnName($col);
171
                }
172
            }
173
174
            return '(' . implode(', ', $columns) . ") $operator $sql";
175
        }
176
177
        if ($columns instanceof ExpressionInterface) {
0 ignored issues
show
introduced by
$columns is never a sub-type of yii\db\ExpressionInterface.
Loading history...
178
            $columns = $columns->expression;
179
        }
180
        if (strpos($columns, '(') === false) {
181
            $columns = $this->queryBuilder->db->quoteColumnName($columns);
182
        }
183
184
        return "$columns $operator $sql";
185
    }
186
187
    /**
188
     * Builds SQL for IN condition.
189
     *
190
     * @param string $operator
191
     * @param array|\Traversable $columns
192
     * @param array $values
193
     * @param array $params
194
     * @return string SQL
195
     */
196
    protected function buildCompositeInCondition($operator, $columns, $values, &$params)
197
    {
198
        $vss = [];
199
        foreach ($values as $value) {
200
            $vs = [];
201
            foreach ($columns as $column) {
202
                if ($column instanceof ExpressionInterface) {
203
                    $column = $column->expression;
0 ignored issues
show
Bug introduced by
Accessing expression on the interface yii\db\ExpressionInterface suggest that you code against a concrete implementation. How about adding an instanceof check?
Loading history...
204
                }
205
                if (isset($value[$column])) {
206
                    $vs[] = $this->queryBuilder->bindParam($value[$column], $params);
207
                } else {
208
                    $vs[] = 'NULL';
209
                }
210
            }
211
            $vss[] = '(' . implode(', ', $vs) . ')';
212
        }
213
214
        if (empty($vss)) {
215
            return $operator === 'IN' ? '0=1' : '';
216
        }
217
218
        $sqlColumns = [];
219
        foreach ($columns as $i => $column) {
220
            if ($column instanceof ExpressionInterface) {
221
                $column = $column->expression;
222
            }
223
            $sqlColumns[] = strpos($column, '(') === false ? $this->queryBuilder->db->quoteColumnName($column) : $column;
224
        }
225
226
        return '(' . implode(', ', $sqlColumns) . ") $operator (" . implode(', ', $vss) . ')';
227
    }
228
229
    /**
230
     * Builds is null/is not null condition for column based on operator
231
     *
232
     * @param string $operator
233
     * @param string $column
234
     * @return string is null or is not null condition
235
     * @since 2.0.31
236
     */
237
    protected function getNullCondition($operator, $column) {
238
        $column = $this->queryBuilder->db->quoteColumnName($column);
239
        if ($operator === 'IN') {
240
            return sprintf('%s IS NULL', $column);
241
        }
242
        return sprintf('%s IS NOT NULL', $column);
243
    }
244
245
    /**
246
     * @param \Traversable $traversableObject
247
     * @return array raw values
248
     * @since 2.0.31
249
     */
250
    protected function getRawValuesFromTraversableObject(\Traversable $traversableObject)
251
    {
252
        $rawValues = [];
253
        foreach ($traversableObject as $value) {
254
            if (is_array($value)) {
255
                $values = array_values($value);
256
                $rawValues = array_merge($rawValues, $values);
257
            } else {
258
                $rawValues[] = $value;
259
            }
260
        }
261
        return $rawValues;
262
    }
263
}
264