Completed
Push — master ( f81184...3aae6e )
by Andrii
04:04
created

ActiveQuery::prepare()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 16
Code Lines 7

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 5
CRAP Score 2.2109

Importance

Changes 0
Metric Value
dl 0
loc 16
ccs 5
cts 8
cp 0.625
rs 9.4285
c 0
b 0
f 0
cc 2
eloc 7
nc 2
nop 1
crap 2.2109
1
<?php
2
/**
3
 * Tools to use API as ActiveRecord for Yii2
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 Connection $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 2
        }
91 2
        if ($this->from === null) {
92 2
            $this->from = $modelClass::from();
0 ignored issues
show
Documentation Bug introduced by
It seems like $modelClass::from() 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 2
        }
94
95 2
        $commandConfig = $db->getQueryBuilder()->build($this);
96
97 2
        return $db->createCommand($commandConfig);
98
    }
99
100
    /**
101
     * Prepares query for use. See NOTE.
102
     * @param QueryBuilder $builder
103
     * @return static
104
     */
105 2
    public function prepare($builder = null)
106
    {
107 2
        $class = $this->modelClass;
108 2
        $class::prepare($this, $builder);
109
110
        // NOTE: because the same ActiveQuery may be used to build different SQL statements
111
        // (e.g. by ActiveDataProvider, one for count query, the other for row data query,
112
        // it is important to make sure the same ActiveQuery can be used to build SQL statements
113
        // multiple times.
114 2
        if (!empty($this->joinWith)) {
115
            $this->buildJoinWith();
116
            $this->joinWith = null;
117
        }
118
119 2
        return $this;
120
    }
121
122
    /**
123
     * @param $with
124
     * @return static
125
     */
126
    public function joinWith($with)
127
    {
128
        $this->joinWith[] = (array) $with;
129
130
        return $this;
131
    }
132
133
    private function buildJoinWith()
134
    {
135
        $join = $this->join;
136
        $this->join = [];
137
138
        $model = new $this->modelClass();
139
140
        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...
141
            $this->joinWithRelations($model, $with);
142
143
            foreach ($with as $name => $callback) {
144
                if (is_int($name)) {
145
                    $this->innerJoin([$callback]);
146
                } else {
147
                    $this->innerJoin([$name => $callback]);
148
                }
149
150
                unset($with[$name]);
151
            }
152
        }
153
154
        if (!empty($join)) {
155
            // append explicit join to joinWith()
156
            // https://github.com/yiisoft/yii2/issues/2880
157
            $this->join = empty($this->join) ? $join : array_merge($this->join, $join);
158
        }
159
160
        if (empty($this->select) || true) {
161
            $this->addSelect(['*' => '*']);
162
            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...
163
                $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...
164
                $closure = array_shift($join);
165
166
                $this->addSelect(is_int($key) ? $closure : $key);
167
            }
168
        }
169
    }
170
171
    /**
172
     * @param ActiveRecord $model
173
     * @param $with
174
     */
175
    protected function joinWithRelations($model, $with)
176
    {
177
        foreach ($with as $name => $callback) {
178
            if (is_int($name)) {
179
                $name = $callback;
180
                $callback = null;
181
            }
182
183
            $primaryModel = $model;
184
            $parent = $this;
185
186
            if (!isset($relations[$name])) {
187
                $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...
188
                if ($callback !== null) {
189
                    call_user_func($callback, $relation);
190
                }
191
                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...
192
                    $relation->buildJoinWith();
193
                }
194
                $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...
195
            }
196
        }
197
    }
198
199
    /**
200
     * Joins a parent query with a child query.
201
     * The current query object will be modified accordingly.
202
     * @param ActiveQuery $parent
203
     * @param ActiveQuery $child
204
     */
205
    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...
206
    {
207
        if (!empty($child->join)) {
208
            foreach ($child->join as $join) {
209
                $this->join[] = $join;
210
            }
211
        }
212
    }
213
214
    public function select($columns, $option = null)
215
    {
216
        $this->select = $columns;
217
218
        return $this;
219
    }
220
221
    /**
222
     * @param array|string $columns
223
     * @return $this
224
     */
225
    public function addSelect($columns)
226
    {
227
        if (!is_array($columns)) {
228
            $columns = (array) $columns;
229
        }
230
231
        if ($this->select === null) {
232
            $this->select = $columns;
233
        } else {
234
            $this->select = array_merge($this->select, $columns);
235
        }
236
237
        return $this;
238
    }
239
240
    /**
241
     * Executes query and returns a single row of result.
242
     *
243
     * @param Connection $db the DB connection used to create the DB command.
244
     * If null, the DB connection returned by [[modelClass]] will be used.
245
     * @return ActiveRecord|array|null a single row of query result. Depending on the setting of [[asArray]],
246
     * the query result may be either an array or an ActiveRecord object. Null will be returned
247
     * if the query results in nothing.
248
     */
249
    public function one($db = null)
250
    {
251
        $row = parent::one($db);
252
253
        return $this->asArray ? $row : 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...
254
    }
255
256
    /**
257
     * Executes query and returns all results as an array.
258
     * @param Connection $db the DB connection used to create the DB command.
259
     * If null, the DB connection returned by [[modelClass]] will be used.
260
     * @return array|ActiveRecord[] the query results. If the query results in nothing, an empty array will be returned.
261
     */
262 2
    public function all($db = null)
263
    {
264 2
        if ($this->asArray) {
265
            return parent::all($db);
266
        }
267
268 2
        $rows = $this->searchAll();
269
270 2
        return $this->populate($rows);
271
    }
272
273 2
    public function populate($rows)
274
    {
275 2
        if (empty($rows)) {
276
            return [];
277
        }
278
279 2
        $models = $this->createModels($rows);
280
281 2
        if (!empty($this->with)) {
282
            $this->findWith($this->with, $models);
283
        }
284
285 2
        foreach ($models as $model) {
286 2
            $model->afterFind();
287 2
        }
288
289 2
        return $models;
290
    }
291
292 2
    private function createModels($rows)
293
    {
294 2
        $models = [];
295 2
        $class = $this->modelClass;
296 2
        foreach ($rows as $row) {
297 2
            $model = $class::instantiate($row);
298 2
            $modelClass = get_class($model);
299 2
            $modelClass::populateRecord($model, $row);
300 2
            $this->populateJoinedRelations($model, $row);
301 2
            if ($this->indexBy) {
302 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...
303
                    $key = call_user_func($this->indexBy, $model);
304
                } else {
305
                    $key = $model->{$this->indexBy};
306
                }
307
                $models[$key] = $model;
308
            } else {
309 2
                $models[] = $model;
310
            }
311 2
        }
312
313 2
        return $models;
314
    }
315
316
    /**
317
     * Populates joined relations from [[join]] array.
318
     *
319
     * @param ActiveRecord $model
320
     * @param array $row
321
     */
322 2
    public function populateJoinedRelations($model, array $row)
323
    {
324 2
        foreach ($row as $key => $value) {
325 2
            if (empty($this->join) || !is_array($value) || $model->hasAttribute($key)) {
326 2
                continue;
327
            }
328
            foreach ($this->join as $join) {
329
                $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...
330
                $closure = array_shift($join);
331
332
                if (is_int($name)) {
333
                    $name = $closure;
334
                    $closure = null;
335
                }
336
                if ($name !== $key) {
337
                    continue;
338
                }
339
                if ($model->isRelationPopulated($name)) {
340
                    continue 2;
341
                }
342
                $records = [];
343
                $relation = $model->getRelation($name);
344
                $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...
345
                if ($closure !== null) {
346
                    call_user_func($closure, $relation);
347
                }
348
                $relation->prepare();
349
350
                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...
351
                    foreach ($value as $item) {
352
                        $relatedModel = $relationClass::instantiate($item);
353
                        $relatedModelClass = get_class($relatedModel);
354
                        $relatedModelClass::populateRecord($relatedModel, $item);
355
                        $relation->populateJoinedRelations($relatedModel, $item);
356
                        $relation->addInverseRelation($relatedModel, $model);
357
                        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...
358
                            $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...
359
                                ? $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...
360
                                : 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...
361
                            $records[$index] = $relatedModel;
362
                        } else {
363
                            $records[] = $relatedModel;
364
                        }
365
                    }
366
                } else {
367
                    $relatedModel = $relationClass::instantiate($value);
368
                    $relatedModelClass = get_class($relatedModel);
369
                    $relatedModelClass::populateRecord($relatedModel, $value);
370
                    $relation->populateJoinedRelations($relatedModel, $value);
371
                    $relation->addInverseRelation($relatedModel, $model);
372
                    $records = $relatedModel;
373
                }
374
375
                $model->populateRelation($name, $records);
376
            }
377 2
        }
378 2
    }
379
380
    /**
381
     * @param $relatedModel
382
     */
383
    private function addInverseRelation($relatedModel)
384
    {
385
        if ($this->inverseOf === null) {
386
            return;
387
        }
388
389
        $inverseRelation = $relatedModel->getRelation($this->inverseOf);
390
        $relatedModel->populateRelation($this->inverseOf, $inverseRelation->multiple ? [$this->primaryModel] : $this->primaryModel);
391
    }
392
}
393