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) |
|
| 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 | // NOTE: because the same ActiveQuery may be used to build different SQL statements |
||
| 108 | // (e.g. by ActiveDataProvider, one for count query, the other for row data query, |
||
| 109 | // it is important to make sure the same ActiveQuery can be used to build SQL statements |
||
| 110 | // multiple times. |
||
| 111 | 2 | if (!empty($this->joinWith)) { |
|
| 112 | $this->buildJoinWith(); |
||
| 113 | $this->joinWith = null; |
||
| 114 | } |
||
| 115 | |||
| 116 | 2 | return $this; |
|
| 117 | 1 | } |
|
| 118 | |||
| 119 | /** |
||
| 120 | * @param $with |
||
| 121 | * @return static |
||
| 122 | */ |
||
| 123 | public function joinWith($with) |
||
| 129 | |||
| 130 | 1 | private function buildJoinWith() |
|
| 131 | { |
||
| 132 | $join = $this->join; |
||
| 133 | $this->join = []; |
||
| 134 | |||
| 135 | $model = new $this->modelClass(); |
||
| 136 | |||
| 137 | foreach ($this->joinWith as $with) { |
||
| 138 | $this->joinWithRelations($model, $with); |
||
| 139 | |||
| 140 | foreach ($with as $name => $callback) { |
||
| 141 | if (is_int($name)) { |
||
| 142 | $this->innerJoin([$callback]); |
||
| 143 | } else { |
||
| 144 | $this->innerJoin([$name => $callback]); |
||
| 145 | } |
||
| 146 | |||
| 147 | unset($with[$name]); |
||
| 148 | } |
||
| 149 | } |
||
| 150 | |||
| 151 | if (!empty($join)) { |
||
| 152 | // append explicit join to joinWith() |
||
| 153 | // https://github.com/yiisoft/yii2/issues/2880 |
||
| 154 | $this->join = empty($this->join) ? $join : array_merge($this->join, $join); |
||
| 155 | } |
||
| 156 | |||
| 157 | if (empty($this->select) || true) { |
||
| 158 | $this->addSelect(['*' => '*']); |
||
| 159 | foreach ($this->joinWith as $join) { |
||
| 160 | $key = array_shift(array_keys($join)); |
||
| 161 | $closure = array_shift($join); |
||
| 162 | |||
| 163 | 1 | $this->addSelect(is_int($key) ? $closure : $key); |
|
| 164 | } |
||
| 165 | } |
||
| 166 | } |
||
| 167 | |||
| 168 | /** |
||
| 169 | * @param ActiveRecord $model |
||
| 170 | * @param $with |
||
| 171 | */ |
||
| 172 | protected function joinWithRelations($model, $with) |
||
| 195 | |||
| 196 | /** |
||
| 197 | * Joins a parent query with a child query. |
||
| 198 | * The current query object will be modified accordingly. |
||
| 199 | * @param ActiveQuery $parent |
||
| 200 | * @param ActiveQuery $child |
||
| 201 | */ |
||
| 202 | private function joinWithRelation($parent, $child) |
||
| 210 | |||
| 211 | public function select($columns, $option = null) |
||
| 217 | |||
| 218 | /** |
||
| 219 | * @param array|string $columns |
||
| 220 | * @return $this |
||
| 221 | */ |
||
| 222 | public function addSelect($columns) |
||
| 236 | |||
| 237 | /** |
||
| 238 | * Executes query and returns a single row of result. |
||
| 239 | * |
||
| 240 | * @param AbstractConnection $db the DB connection used to create the DB command. |
||
| 241 | * If null, the DB connection returned by [[modelClass]] will be used. |
||
| 242 | * @return ActiveRecord|array|null a single row of query result. Depending on the setting of [[asArray]], |
||
| 243 | * the query result may be either an array or an ActiveRecord object. Null will be returned |
||
| 244 | * if the query results in nothing. |
||
| 245 | */ |
||
| 246 | public function one($db = null) |
||
| 259 | |||
| 260 | /** |
||
| 261 | * Executes query and returns all results as an array. |
||
| 262 | * @param AbstractConnection $db the DB connection used to create the DB command. |
||
| 263 | * If null, the DB connection returned by [[modelClass]] will be used. |
||
| 264 | * @return array|ActiveRecord[] the query results. If the query results in nothing, an empty array will be returned. |
||
| 265 | */ |
||
| 266 | 2 | public function all($db = null) |
|
| 276 | |||
| 277 | 2 | public function populate($rows) |
|
| 295 | |||
| 296 | 2 | private function createModels($rows) |
|
| 319 | |||
| 320 | /** |
||
| 321 | * Populates joined relations from [[join]] array. |
||
| 322 | * |
||
| 323 | * @param ActiveRecord $model |
||
| 324 | * @param array $row |
||
| 325 | */ |
||
| 326 | 2 | public function populateJoinedRelations($model, array $row) |
|
| 383 | |||
| 384 | /** |
||
| 385 | * @param $relatedModel |
||
| 386 | */ |
||
| 387 | private function addInverseRelation($relatedModel) |
||
| 396 | } |
||
| 397 |
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..