Completed
Push — master ( c30967...3bd52a )
by Andrii
03:06
created

ActiveQuery::select()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 6
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 2

Importance

Changes 0
Metric Value
dl 0
loc 6
ccs 0
cts 3
cp 0
rs 9.4285
c 0
b 0
f 0
cc 1
eloc 3
nc 1
nop 2
crap 2
1
<?php
2
/**
3
 * ActiveRecord for API
4
 *
5
 * @link      https://github.com/hiqdev/yii2-hiart
6
 * @package   yii2-hiart
7
 * @license   BSD-3-Clause
8
 * @copyright Copyright (c) 2015-2017, HiQDev (http://hiqdev.com/)
9
 */
10
11
namespace hiqdev\hiart;
12
13
use hiqdev\hiart\rest\QueryBuilder;
14
use yii\db\ActiveQueryInterface;
15
use yii\db\ActiveQueryTrait;
16
use yii\db\ActiveRelationTrait;
17
18
class ActiveQuery extends Query implements ActiveQueryInterface
19
{
20
    use ActiveQueryTrait;
21
    use ActiveRelationTrait;
22
23
    /**
24
     * @event Event an event that is triggered when the query is initialized via [[init()]].
25
     */
26
    const EVENT_INIT = 'init';
27
28
    /**
29
     * @var array|null a list of relations that this query should be joined with
30
     */
31
    public $joinWith = [];
32
33
    /**
34
     * Constructor.
35
     * @param string $modelClass the model class associated with this query
36
     * @param array $config configurations to be applied to the newly created query object
37
     */
38 2
    public function __construct($modelClass, $config = [])
39
    {
40 2
        $this->modelClass = $modelClass;
41
42 2
        parent::__construct($config);
43 2
    }
44
45
    /**
46
     * Initializes the object.
47
     * This method is called at the end of the constructor. The default implementation will trigger
48
     * an [[EVENT_INIT]] event. If you override this method, make sure you call the parent implementation at the end
49
     * to ensure triggering of the event.
50
     */
51 2
    public function init()
52
    {
53 2
        parent::init();
54 2
        $this->trigger(self::EVENT_INIT);
55 2
    }
56
57
    /**
58
     * Creates a DB command that can be used to execute this query.
59
     * @param AbstractConnection $db the DB connection used to create the DB command.
60
     * If null, the DB connection returned by [[modelClass]] will be used.
61
     * @return Command the created DB command instance
62
     */
63 2
    public function createCommand($db = null)
64
    {
65 2
        if ($this->primaryModel !== null) {
66
            // lazy loading
67
            if (is_array($this->via)) {
68
                // via relation
69
                /** @var $viaQuery ActiveQuery */
70
                list($viaName, $viaQuery) = $this->via;
71
                if ($viaQuery->multiple) {
72
                    $viaModels = $viaQuery->all();
73
                    $this->primaryModel->populateRelation($viaName, $viaModels);
74
                } else {
75
                    $model = $viaQuery->one();
76
                    $this->primaryModel->populateRelation($viaName, $model);
77
                    $viaModels = $model === null ? [] : [$model];
78
                }
79
                $this->filterByModels($viaModels);
80
            } else {
81
                $this->filterByModels([$this->primaryModel]);
82
            }
83
        }
84
85
        /* @var $modelClass ActiveRecord */
86 2
        $modelClass = $this->modelClass;
87
88 2
        if ($db === null) {
89 2
            $db = $modelClass::getDb();
90
        }
91 2
        if ($this->from === null) {
92 2
            $this->from = $modelClass::tableName();
0 ignored issues
show
Documentation Bug introduced by
It seems like $modelClass::tableName() of type string is incompatible with the declared type array of property $from.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
93
        }
94
95 2
        return parent::createCommand($db);
96
    }
97
98
    /**
99
     * Prepares query for use. See NOTE.
100
     * @param QueryBuilder $builder
101
     * @return static
102
     */
103 2
    public function prepare($builder = null)
104
    {
105
        // NOTE: because the same ActiveQuery may be used to build different SQL statements
106
        // (e.g. by ActiveDataProvider, one for count query, the other for row data query,
107
        // it is important to make sure the same ActiveQuery can be used to build SQL statements
108
        // multiple times.
109 2
        if (!empty($this->joinWith)) {
110
            $this->buildJoinWith();
111
            $this->joinWith = null;
112
        }
113
114 2
        return $this;
115
    }
116
117
    /**
118
     * @param $with
119
     * @return static
120
     */
121
    public function joinWith($with)
122
    {
123
        $this->joinWith[] = (array) $with;
124
125
        return $this;
126
    }
127
128
    private function buildJoinWith()
129
    {
130
        $join = $this->join;
131
        $this->join = [];
132
133
        $model = new $this->modelClass();
134
135
        foreach ($this->joinWith as $with) {
0 ignored issues
show
Bug introduced by
The expression $this->joinWith of type array|null is not guaranteed to be traversable. How about adding an additional type check?

There are different options of fixing this problem.

  1. If you want to be on the safe side, you can add an additional type-check:

    $collection = json_decode($data, true);
    if ( ! is_array($collection)) {
        throw new \RuntimeException('$collection must be an array.');
    }
    
    foreach ($collection as $item) { /** ... */ }
    
  2. If you are sure that the expression is traversable, you might want to add a doc comment cast to improve IDE auto-completion and static analysis:

    /** @var array $collection */
    $collection = json_decode($data, true);
    
    foreach ($collection as $item) { /** .. */ }
    
  3. Mark the issue as a false-positive: Just hover the remove button, in the top-right corner of this issue for more options.

Loading history...
136
            $this->joinWithRelations($model, $with);
137
138
            foreach ($with as $name => $callback) {
139
                if (is_int($name)) {
140
                    $this->innerJoin([$callback]);
141
                } else {
142
                    $this->innerJoin([$name => $callback]);
143
                }
144
145
                unset($with[$name]);
146
            }
147
        }
148
149
        if (!empty($join)) {
150
            // append explicit join to joinWith()
151
            // https://github.com/yiisoft/yii2/issues/2880
152
            $this->join = empty($this->join) ? $join : array_merge($this->join, $join);
153
        }
154
155
        if (empty($this->select) || true) {
156
            $this->addSelect(['*' => '*']);
157
            foreach ($this->joinWith as $join) {
0 ignored issues
show
Bug introduced by
The expression $this->joinWith of type array|null is not guaranteed to be traversable. How about adding an additional type check?

There are different options of fixing this problem.

  1. If you want to be on the safe side, you can add an additional type-check:

    $collection = json_decode($data, true);
    if ( ! is_array($collection)) {
        throw new \RuntimeException('$collection must be an array.');
    }
    
    foreach ($collection as $item) { /** ... */ }
    
  2. If you are sure that the expression is traversable, you might want to add a doc comment cast to improve IDE auto-completion and static analysis:

    /** @var array $collection */
    $collection = json_decode($data, true);
    
    foreach ($collection as $item) { /** .. */ }
    
  3. Mark the issue as a false-positive: Just hover the remove button, in the top-right corner of this issue for more options.

Loading history...
158
                $key = array_shift(array_keys($join));
0 ignored issues
show
Bug introduced by
array_keys($join) cannot be passed to array_shift() as the parameter $array expects a reference.
Loading history...
159
                $closure = array_shift($join);
160
161
                $this->addSelect(is_int($key) ? $closure : $key);
162
            }
163
        }
164
    }
165
166
    /**
167
     * @param ActiveRecord $model
168
     * @param $with
169
     */
170
    protected function joinWithRelations($model, $with)
171
    {
172
        foreach ($with as $name => $callback) {
173
            if (is_int($name)) {
174
                $name = $callback;
175
                $callback = null;
176
            }
177
178
            $primaryModel = $model;
179
            $parent = $this;
180
181
            if (!isset($relations[$name])) {
182
                $relations[$name] = $relation = $primaryModel->getRelation($name);
0 ignored issues
show
Bug introduced by
The variable $relations does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
183
                if ($callback !== null) {
184
                    call_user_func($callback, $relation);
185
                }
186
                if (!empty($relation->joinWith)) {
0 ignored issues
show
Bug introduced by
Accessing joinWith on the interface yii\db\ActiveQueryInterface suggest that you code against a concrete implementation. How about adding an instanceof check?

If you access a property on an interface, you most likely code against a concrete implementation of the interface.

Available Fixes

  1. Adding an additional type check:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeInterface $object) {
        if ($object instanceof SomeClass) {
            $a = $object->a;
        }
    }
    
  2. Changing the type hint:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeClass $object) {
        $a = $object->a;
    }
    
Loading history...
187
                    $relation->buildJoinWith();
188
                }
189
                $this->joinWithRelation($parent, $relation);
0 ignored issues
show
Compatibility introduced by
$relation of type object<yii\db\ActiveQueryInterface> is not a sub-type of object<hiqdev\hiart\ActiveQuery>. It seems like you assume a concrete implementation of the interface yii\db\ActiveQueryInterface to be always present.

This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass.

Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type.

Loading history...
190
            }
191
        }
192
    }
193
194
    /**
195
     * Joins a parent query with a child query.
196
     * The current query object will be modified accordingly.
197
     * @param ActiveQuery $parent
198
     * @param ActiveQuery $child
199
     */
200
    private function joinWithRelation($parent, $child)
0 ignored issues
show
Unused Code introduced by
The parameter $parent is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
201
    {
202
        if (!empty($child->join)) {
203
            foreach ($child->join as $join) {
204
                $this->join[] = $join;
205
            }
206
        }
207
    }
208
209
    public function select($columns, $option = null)
210
    {
211
        $this->select = $columns;
212
213
        return $this;
214
    }
215
216
    /**
217
     * @param array|string $columns
218
     * @return $this
219
     */
220
    public function addSelect($columns)
221
    {
222
        if (!is_array($columns)) {
223
            $columns = (array) $columns;
224
        }
225
226
        if ($this->select === null) {
227
            $this->select = $columns;
228
        } else {
229
            $this->select = array_merge($this->select, $columns);
230
        }
231
232
        return $this;
233
    }
234
235
    /**
236
     * Executes query and returns a single row of result.
237
     *
238
     * @param AbstractConnection $db the DB connection used to create the DB command.
239
     * If null, the DB connection returned by [[modelClass]] will be used.
240
     * @return ActiveRecord|array|null a single row of query result. Depending on the setting of [[asArray]],
241
     * the query result may be either an array or an ActiveRecord object. Null will be returned
242
     * if the query results in nothing.
243
     */
244
    public function one($db = null)
245
    {
246
        if ($this->asArray) {
247
            return parent::one($db);
0 ignored issues
show
Bug introduced by
It seems like $db defined by parameter $db on line 244 can also be of type object<hiqdev\hiart\AbstractConnection>; however, hiqdev\hiart\Query::one() does only seem to accept object<yii\db\Connection>|null, maybe add an additional type check?

This check looks at variables that have been passed in as parameters and are passed out again to other methods.

If the outgoing method call has stricter type requirements than the method itself, an issue is raised.

An additional type check may prevent trouble.

Loading history...
Bug Compatibility introduced by
The expression parent::one($db); of type array|boolean adds the type boolean to the return on line 247 which is incompatible with the return type declared by the interface yii\db\ActiveQueryInterface::one of type yii\db\ActiveRecordInterface|array|null.
Loading history...
248
        }
249
250
        $row = $this->searchOne($db);
251
        if ($row === null) {
252
            return null;
253
        }
254
255
        return reset($this->populate([$row]));
0 ignored issues
show
Bug introduced by
$this->populate(array($row)) cannot be passed to reset() as the parameter $array expects a reference.
Loading history...
256
    }
257
258
    /**
259
     * Executes query and returns all results as an array.
260
     * @param AbstractConnection $db the DB connection used to create the DB command.
261
     * If null, the DB connection returned by [[modelClass]] will be used.
262
     * @return array|ActiveRecord[] the query results. If the query results in nothing, an empty array will be returned.
263
     */
264 2
    public function all($db = null)
265
    {
266 2
        if ($this->asArray) {
267
            return parent::all($db);
0 ignored issues
show
Bug introduced by
It seems like $db defined by parameter $db on line 264 can also be of type object<hiqdev\hiart\AbstractConnection>; however, hiqdev\hiart\Query::all() does only seem to accept object<yii\db\Connection>|null, maybe add an additional type check?

This check looks at variables that have been passed in as parameters and are passed out again to other methods.

If the outgoing method call has stricter type requirements than the method itself, an issue is raised.

An additional type check may prevent trouble.

Loading history...
268
        }
269
270 2
        $rows = $this->searchAll();
271
272 2
        return $this->populate($rows);
273
    }
274
275 2
    public function populate($rows)
276
    {
277 2
        if (empty($rows)) {
278
            return [];
279
        }
280
281 2
        $models = $this->createModels($rows);
282
283 2
        if (!empty($this->with)) {
284
            $this->findWith($this->with, $models);
285
        }
286
287 2
        foreach ($models as $model) {
288 2
            $model->afterFind();
289
        }
290
291 2
        return $models;
292
    }
293
294 2
    private function createModels($rows)
295
    {
296 2
        $models = [];
297 2
        $class = $this->modelClass;
298 2
        foreach ($rows as $row) {
299 2
            $model = $class::instantiate($row);
300 2
            $modelClass = get_class($model);
301 2
            $modelClass::populateRecord($model, $row);
302 2
            $this->populateJoinedRelations($model, $row);
303 2
            if ($this->indexBy) {
304 View Code Duplication
                if ($this->indexBy instanceof \Closure) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
305
                    $key = call_user_func($this->indexBy, $model);
306
                } else {
307
                    $key = $model->{$this->indexBy};
308
                }
309
                $models[$key] = $model;
310
            } else {
311 2
                $models[] = $model;
312
            }
313
        }
314
315 2
        return $models;
316
    }
317
318
    /**
319
     * Populates joined relations from [[join]] array.
320
     *
321
     * @param ActiveRecord $model
322
     * @param array $row
323
     */
324 2
    public function populateJoinedRelations($model, array $row)
325
    {
326 2
        foreach ($row as $key => $value) {
327 2
            if (empty($this->join) || !is_array($value) || $model->hasAttribute($key)) {
328 2
                continue;
329
            }
330
            foreach ($this->join as $join) {
331
                $name = array_shift(array_keys($join));
0 ignored issues
show
Bug introduced by
array_keys($join) cannot be passed to array_shift() as the parameter $array expects a reference.
Loading history...
332
                $closure = array_shift($join);
333
334
                if (is_int($name)) {
335
                    $name = $closure;
336
                    $closure = null;
337
                }
338
                if ($name !== $key) {
339
                    continue;
340
                }
341
                if ($model->isRelationPopulated($name)) {
342
                    continue 2;
343
                }
344
                $records = [];
345
                $relation = $model->getRelation($name);
346
                $relationClass = $relation->modelClass;
0 ignored issues
show
Bug introduced by
Accessing modelClass on the interface yii\db\ActiveQueryInterface suggest that you code against a concrete implementation. How about adding an instanceof check?

If you access a property on an interface, you most likely code against a concrete implementation of the interface.

Available Fixes

  1. Adding an additional type check:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeInterface $object) {
        if ($object instanceof SomeClass) {
            $a = $object->a;
        }
    }
    
  2. Changing the type hint:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeClass $object) {
        $a = $object->a;
    }
    
Loading history...
347
                if ($closure !== null) {
348
                    call_user_func($closure, $relation);
349
                }
350
                $relation->prepare();
351
352
                if ($relation->multiple) {
0 ignored issues
show
Bug introduced by
Accessing multiple on the interface yii\db\ActiveQueryInterface suggest that you code against a concrete implementation. How about adding an instanceof check?

If you access a property on an interface, you most likely code against a concrete implementation of the interface.

Available Fixes

  1. Adding an additional type check:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeInterface $object) {
        if ($object instanceof SomeClass) {
            $a = $object->a;
        }
    }
    
  2. Changing the type hint:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeClass $object) {
        $a = $object->a;
    }
    
Loading history...
353
                    foreach ($value as $item) {
354
                        $relatedModel = $relationClass::instantiate($item);
355
                        $relatedModelClass = get_class($relatedModel);
356
                        $relatedModelClass::populateRecord($relatedModel, $item);
357
                        $relation->populateJoinedRelations($relatedModel, $item);
358
                        $relation->addInverseRelation($relatedModel, $model);
359
                        if ($relation->indexBy !== null) {
0 ignored issues
show
Bug introduced by
Accessing indexBy on the interface yii\db\ActiveQueryInterface suggest that you code against a concrete implementation. How about adding an instanceof check?

If you access a property on an interface, you most likely code against a concrete implementation of the interface.

Available Fixes

  1. Adding an additional type check:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeInterface $object) {
        if ($object instanceof SomeClass) {
            $a = $object->a;
        }
    }
    
  2. Changing the type hint:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeClass $object) {
        $a = $object->a;
    }
    
Loading history...
360
                            $index = is_string($relation->indexBy)
0 ignored issues
show
Bug introduced by
Accessing indexBy on the interface yii\db\ActiveQueryInterface suggest that you code against a concrete implementation. How about adding an instanceof check?

If you access a property on an interface, you most likely code against a concrete implementation of the interface.

Available Fixes

  1. Adding an additional type check:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeInterface $object) {
        if ($object instanceof SomeClass) {
            $a = $object->a;
        }
    }
    
  2. Changing the type hint:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeClass $object) {
        $a = $object->a;
    }
    
Loading history...
361
                                ? $relatedModel[$relation->indexBy]
0 ignored issues
show
Bug introduced by
Accessing indexBy on the interface yii\db\ActiveQueryInterface suggest that you code against a concrete implementation. How about adding an instanceof check?

If you access a property on an interface, you most likely code against a concrete implementation of the interface.

Available Fixes

  1. Adding an additional type check:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeInterface $object) {
        if ($object instanceof SomeClass) {
            $a = $object->a;
        }
    }
    
  2. Changing the type hint:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeClass $object) {
        $a = $object->a;
    }
    
Loading history...
362
                                : call_user_func($relation->indexBy, $relatedModel);
0 ignored issues
show
Bug introduced by
Accessing indexBy on the interface yii\db\ActiveQueryInterface suggest that you code against a concrete implementation. How about adding an instanceof check?

If you access a property on an interface, you most likely code against a concrete implementation of the interface.

Available Fixes

  1. Adding an additional type check:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeInterface $object) {
        if ($object instanceof SomeClass) {
            $a = $object->a;
        }
    }
    
  2. Changing the type hint:

    interface SomeInterface { }
    class SomeClass implements SomeInterface {
        public $a;
    }
    
    function someFunction(SomeClass $object) {
        $a = $object->a;
    }
    
Loading history...
363
                            $records[$index] = $relatedModel;
364
                        } else {
365
                            $records[] = $relatedModel;
366
                        }
367
                    }
368
                } else {
369
                    $relatedModel = $relationClass::instantiate($value);
370
                    $relatedModelClass = get_class($relatedModel);
371
                    $relatedModelClass::populateRecord($relatedModel, $value);
372
                    $relation->populateJoinedRelations($relatedModel, $value);
373
                    $relation->addInverseRelation($relatedModel, $model);
374
                    $records = $relatedModel;
375
                }
376
377
                $model->populateRelation($name, $records);
378
            }
379
        }
380 2
    }
381
382
    /**
383
     * @param $relatedModel
384
     */
385
    private function addInverseRelation($relatedModel)
386
    {
387
        if ($this->inverseOf === null) {
388
            return;
389
        }
390
391
        $inverseRelation = $relatedModel->getRelation($this->inverseOf);
392
        $relatedModel->populateRelation($this->inverseOf, $inverseRelation->multiple ? [$this->primaryModel] : $this->primaryModel);
393
    }
394
}
395