yiisoft /
yii2
Complex classes like ActiveRelationTrait 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 ActiveRelationTrait, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 24 | trait ActiveRelationTrait |
||
| 25 | { |
||
| 26 | /** |
||
| 27 | * @var bool whether this query represents a relation to more than one record. |
||
| 28 | * This property is only used in relational context. If true, this relation will |
||
| 29 | * populate all query results into AR instances using [[Query::all()|all()]]. |
||
| 30 | * If false, only the first row of the results will be retrieved using [[Query::one()|one()]]. |
||
| 31 | */ |
||
| 32 | public $multiple; |
||
| 33 | /** |
||
| 34 | * @var ActiveRecord the primary model of a relational query. |
||
| 35 | * This is used only in lazy loading with dynamic query options. |
||
| 36 | */ |
||
| 37 | public $primaryModel; |
||
| 38 | /** |
||
| 39 | * @var array the columns of the primary and foreign tables that establish a relation. |
||
| 40 | * The array keys must be columns of the table for this relation, and the array values |
||
| 41 | * must be the corresponding columns from the primary table. |
||
| 42 | * Do not prefix or quote the column names as this will be done automatically by Yii. |
||
| 43 | * This property is only used in relational context. |
||
| 44 | */ |
||
| 45 | public $link; |
||
| 46 | /** |
||
| 47 | * @var array|object the query associated with the junction table. Please call [[via()]] |
||
| 48 | * to set this property instead of directly setting it. |
||
| 49 | * This property is only used in relational context. |
||
| 50 | * @see via() |
||
| 51 | */ |
||
| 52 | public $via; |
||
| 53 | /** |
||
| 54 | * @var string the name of the relation that is the inverse of this relation. |
||
| 55 | * For example, an order has a customer, which means the inverse of the "customer" relation |
||
| 56 | * is the "orders", and the inverse of the "orders" relation is the "customer". |
||
| 57 | * If this property is set, the primary record(s) will be referenced through the specified relation. |
||
| 58 | * For example, `$customer->orders[0]->customer` and `$customer` will be the same object, |
||
| 59 | * and accessing the customer of an order will not trigger new DB query. |
||
| 60 | * This property is only used in relational context. |
||
| 61 | * @see inverseOf() |
||
| 62 | */ |
||
| 63 | public $inverseOf; |
||
| 64 | |||
| 65 | |||
| 66 | /** |
||
| 67 | * Clones internal objects. |
||
| 68 | */ |
||
| 69 | 12 | public function __clone() |
|
| 79 | |||
| 80 | /** |
||
| 81 | * Specifies the relation associated with the junction table. |
||
| 82 | * |
||
| 83 | * Use this method to specify a pivot record/table when declaring a relation in the [[ActiveRecord]] class: |
||
| 84 | * |
||
| 85 | * ```php |
||
| 86 | * class Order extends ActiveRecord |
||
| 87 | * { |
||
| 88 | * public function getOrderItems() { |
||
| 89 | * return $this->hasMany(OrderItem::className(), ['order_id' => 'id']); |
||
| 90 | * } |
||
| 91 | * |
||
| 92 | * public function getItems() { |
||
| 93 | * return $this->hasMany(Item::className(), ['id' => 'item_id']) |
||
| 94 | * ->via('orderItems'); |
||
| 95 | * } |
||
| 96 | * } |
||
| 97 | * ``` |
||
| 98 | * |
||
| 99 | * @param string $relationName the relation name. This refers to a relation declared in [[primaryModel]]. |
||
| 100 | * @param callable $callable a PHP callback for customizing the relation associated with the junction table. |
||
| 101 | * Its signature should be `function($query)`, where `$query` is the query to be customized. |
||
| 102 | * @return $this the relation object itself. |
||
| 103 | */ |
||
| 104 | 60 | public function via($relationName, callable $callable = null) |
|
| 113 | |||
| 114 | /** |
||
| 115 | * Sets the name of the relation that is the inverse of this relation. |
||
| 116 | * For example, an order has a customer, which means the inverse of the "customer" relation |
||
| 117 | * is the "orders", and the inverse of the "orders" relation is the "customer". |
||
| 118 | * If this property is set, the primary record(s) will be referenced through the specified relation. |
||
| 119 | * For example, `$customer->orders[0]->customer` and `$customer` will be the same object, |
||
| 120 | * and accessing the customer of an order will not trigger a new DB query. |
||
| 121 | * |
||
| 122 | * Use this method when declaring a relation in the [[ActiveRecord]] class: |
||
| 123 | * |
||
| 124 | * ```php |
||
| 125 | * public function getOrders() |
||
| 126 | * { |
||
| 127 | * return $this->hasMany(Order::className(), ['customer_id' => 'id'])->inverseOf('customer'); |
||
| 128 | * } |
||
| 129 | * ``` |
||
| 130 | * |
||
| 131 | * @param string $relationName the name of the relation that is the inverse of this relation. |
||
| 132 | * @return $this the relation object itself. |
||
| 133 | */ |
||
| 134 | 6 | public function inverseOf($relationName) |
|
| 139 | |||
| 140 | /** |
||
| 141 | * Finds the related records for the specified primary record. |
||
| 142 | * This method is invoked when a relation of an ActiveRecord is being accessed in a lazy fashion. |
||
| 143 | * @param string $name the relation name |
||
| 144 | * @param ActiveRecordInterface|BaseActiveRecord $model the primary model |
||
| 145 | * @return mixed the related record(s) |
||
| 146 | * @throws InvalidParamException if the relation is invalid |
||
| 147 | */ |
||
| 148 | 52 | public function findFor($name, $model) |
|
| 160 | |||
| 161 | /** |
||
| 162 | * If applicable, populate the query's primary model into the related records' inverse relationship |
||
| 163 | * @param array $result the array of related records as generated by [[populate()]] |
||
| 164 | * @since 2.0.9 |
||
| 165 | */ |
||
| 166 | 6 | private function addInverseRelations(&$result) |
|
| 186 | |||
| 187 | /** |
||
| 188 | * Finds the related records and populates them into the primary models. |
||
| 189 | * @param string $name the relation name |
||
| 190 | * @param array $primaryModels primary models |
||
| 191 | * @return array the related models |
||
| 192 | * @throws InvalidConfigException if [[link]] is invalid |
||
| 193 | */ |
||
| 194 | 63 | public function populateRelation($name, &$primaryModels) |
|
| 287 | |||
| 288 | /** |
||
| 289 | * @param ActiveRecordInterface[] $primaryModels primary models |
||
| 290 | * @param ActiveRecordInterface[] $models models |
||
| 291 | * @param string $primaryName the primary relation name |
||
| 292 | * @param string $name the relation name |
||
| 293 | */ |
||
| 294 | 6 | private function populateInverseRelation(&$primaryModels, $models, $primaryName, $name) |
|
| 345 | |||
| 346 | /** |
||
| 347 | * @param array $models |
||
| 348 | * @param array $link |
||
| 349 | * @param array $viaModels |
||
| 350 | * @param array $viaLink |
||
| 351 | * @param bool $checkMultiple |
||
| 352 | * @return array |
||
| 353 | */ |
||
| 354 | 57 | private function buildBuckets($models, $link, $viaModels = null, $viaLink = null, $checkMultiple = true) |
|
| 394 | |||
| 395 | |||
| 396 | /** |
||
| 397 | * Indexes buckets by column name. |
||
| 398 | * |
||
| 399 | * @param array $buckets |
||
| 400 | * @var string|callable $column the name of the column by which the query results should be indexed by. |
||
| 401 | * This can also be a callable (e.g. anonymous function) that returns the index value based on the given row data. |
||
| 402 | * @return array |
||
| 403 | */ |
||
| 404 | 15 | private function indexBuckets($buckets, $indexBy) |
|
| 416 | |||
| 417 | /** |
||
| 418 | * @param array $attributes the attributes to prefix |
||
| 419 | * @return array |
||
| 420 | */ |
||
| 421 | 124 | private function prefixKeyColumns($attributes) |
|
| 444 | |||
| 445 | /** |
||
| 446 | * @param array $models |
||
| 447 | */ |
||
| 448 | 124 | private function filterByModels($models) |
|
| 491 | |||
| 492 | /** |
||
| 493 | * @param ActiveRecordInterface|array $model |
||
| 494 | * @param array $attributes |
||
| 495 | * @return string |
||
| 496 | */ |
||
| 497 | 57 | private function getModelKey($model, $attributes) |
|
| 509 | |||
| 510 | /** |
||
| 511 | * @param mixed $value raw key value. |
||
| 512 | * @return string normalized key value. |
||
| 513 | */ |
||
| 514 | 57 | private function normalizeModelKey($value) |
|
| 522 | |||
| 523 | /** |
||
| 524 | * @param array $primaryModels either array of AR instances or arrays |
||
| 525 | * @return array |
||
| 526 | */ |
||
| 527 | 21 | private function findJunctionRows($primaryModels) |
|
| 542 | } |
||
| 543 |
Loading history...
In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:
Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: