hiqdev /
yii2-hiart
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like ActiveQuery often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use ActiveQuery, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 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 = []) |
|
| 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() |
|
| 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(); |
|
|
|
|||
| 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) |
||
| 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) { |
||
| 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) { |
||
| 158 | $key = array_shift(array_keys($join)); |
||
| 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); |
||
| 183 | if ($callback !== null) { |
||
| 184 | call_user_func($callback, $relation); |
||
| 185 | } |
||
| 186 | if (!empty($relation->joinWith)) { |
||
| 187 | $relation->buildJoinWith(); |
||
| 188 | } |
||
| 189 | $this->joinWithRelation($parent, $relation); |
||
| 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) |
||
| 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) |
||
| 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) |
||
| 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) |
|
| 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) { |
|
| 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)); |
||
| 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; |
||
| 347 | if ($closure !== null) { |
||
| 348 | call_user_func($closure, $relation); |
||
| 349 | } |
||
| 350 | $relation->prepare(); |
||
| 351 | |||
| 352 | if ($relation->multiple) { |
||
| 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) { |
||
| 360 | $index = is_string($relation->indexBy) |
||
| 361 | ? $relatedModel[$relation->indexBy] |
||
| 362 | : call_user_func($relation->indexBy, $relatedModel); |
||
| 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) |
||
| 394 | } |
||
| 395 |
Loading history...
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..