paulzi /
yii2-auto-tree
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:
| 1 | <?php |
||
| 7 | trait AutoTreeTrait |
||
| 8 | { |
||
| 9 | /** |
||
| 10 | * @var \yii\base\Behavior[] |
||
| 11 | */ |
||
| 12 | private $_autoTreeMap; |
||
| 13 | |||
| 14 | private $_autoTreeReturnBehavior = false; |
||
| 15 | |||
| 16 | |||
| 17 | /** |
||
| 18 | * @return array |
||
| 19 | */ |
||
| 20 | 61 | private static function autoTreeAliases() |
|
| 21 | { |
||
| 22 | return [ |
||
| 23 | 61 | 'paulzi\adjacencyList\AdjacencyListBehavior' => 'al', |
|
| 24 | 61 | 'paulzi\adjacencylist\AdjacencyListBehavior' => 'al', |
|
| 25 | 61 | 'paulzi\nestedSets\NestedSetsBehavior' => 'ns', |
|
| 26 | 61 | 'paulzi\nestedsets\NestedSetsBehavior' => 'ns', |
|
| 27 | 61 | 'paulzi\nestedIntervals\NestedIntervalsBehavior' => 'ni', |
|
| 28 | 61 | 'paulzi\nestedintervals\NestedIntervalsBehavior' => 'ni', |
|
| 29 | 61 | 'paulzi\materializedPath\MaterializedPathBehavior' => 'mp', |
|
| 30 | 61 | 'paulzi\materializedpath\MaterializedPathBehavior' => 'mp', |
|
| 31 | 61 | ]; |
|
| 32 | } |
||
| 33 | |||
| 34 | /** |
||
| 35 | * |
||
| 36 | */ |
||
| 37 | 61 | private function autoTreeInit() |
|
| 48 | |||
| 49 | /** |
||
| 50 | * @param string $method |
||
| 51 | * @param array $list |
||
| 52 | * @param array $arguments |
||
| 53 | * @param bool $firstOnly |
||
| 54 | * @return mixed |
||
| 55 | */ |
||
| 56 | 61 | private function autoTreeCall($method, $list, $arguments = [], $firstOnly = true) |
|
| 57 | { |
||
| 58 | 61 | if ($this->_autoTreeMap === null) { |
|
| 59 | 61 | $this->autoTreeInit(); |
|
| 60 | 61 | } |
|
| 61 | |||
| 62 | 61 | $result = null; |
|
| 63 | 61 | $founded = false; |
|
| 64 | 61 | foreach ($list as $alias) { |
|
| 65 | 61 | if (isset($this->_autoTreeMap[$alias])) { |
|
| 66 | 61 | $behavior = $this->_autoTreeMap[$alias]; |
|
| 67 | 61 | if (method_exists($behavior, $method)) { |
|
| 68 | 61 | if ($this->_autoTreeReturnBehavior) { |
|
| 69 | 6 | return $behavior; |
|
| 70 | } |
||
| 71 | 61 | $founded = true; |
|
| 72 | 61 | $result = call_user_func_array([$behavior, $method], $arguments); |
|
| 73 | 61 | if ($firstOnly) { |
|
| 74 | 53 | return $result; |
|
| 75 | } |
||
| 76 | 27 | } |
|
| 77 | 27 | } |
|
| 78 | 43 | } |
|
| 79 | |||
| 80 | 27 | if (!$founded) { |
|
| 81 | throw new InvalidCallException("Method '{$method}' not founded"); |
||
| 82 | } |
||
| 83 | |||
| 84 | 27 | return $result; |
|
| 85 | } |
||
| 86 | |||
| 87 | /** |
||
| 88 | * @inheritdoc |
||
| 89 | */ |
||
| 90 | 51 | public function __get($name) |
|
| 91 | { |
||
| 92 | /** @var \yii\db\BaseActiveRecord|self $this */ |
||
| 93 | // replace getParents() by getParentsOrdered() if behavior not support ordered query |
||
| 94 | 51 | View Code Duplication | if ($name === 'parents') { |
| 95 | 3 | $this->_autoTreeReturnBehavior = true; |
|
| 96 | 3 | $behavior = $this->getParents(); |
|
| 97 | 3 | $this->_autoTreeReturnBehavior = false; |
|
| 98 | 3 | if (method_exists($behavior, 'getParentsOrdered')) { |
|
| 99 | $this->populateRelation($name, $behavior->getParentsOrdered()); |
||
| 100 | } |
||
| 101 | 3 | } |
|
| 102 | 51 | View Code Duplication | if ($name === 'descendants') { |
| 103 | 3 | $this->_autoTreeReturnBehavior = true; |
|
| 104 | 3 | $behavior = $this->getDescendants(); |
|
| 105 | 3 | $this->_autoTreeReturnBehavior = false; |
|
| 106 | 3 | if (method_exists($behavior, 'getDescendantsOrdered')) { |
|
| 107 | $this->populateRelation($name, $behavior->getDescendantsOrdered()); |
||
| 108 | } |
||
| 109 | 3 | } |
|
| 110 | 51 | return parent::__get($name); |
|
| 111 | } |
||
| 112 | |||
| 113 | /** |
||
| 114 | * @param int|null $depth |
||
| 115 | * @return \yii\db\ActiveQuery |
||
| 116 | */ |
||
| 117 | 3 | public function getParents($depth = null) |
|
| 121 | |||
| 122 | /** |
||
| 123 | * @return \yii\db\ActiveQuery |
||
| 124 | */ |
||
| 125 | 3 | public function getParent() |
|
| 129 | |||
| 130 | /** |
||
| 131 | * @return \yii\db\ActiveQuery |
||
| 132 | */ |
||
| 133 | 3 | public function getRoot() |
|
| 137 | |||
| 138 | /** |
||
| 139 | * @param int|null $depth |
||
| 140 | * @param bool $andSelf |
||
| 141 | * @return \yii\db\ActiveQuery |
||
| 142 | */ |
||
| 143 | 5 | public function getDescendants($depth = null, $andSelf = false) |
|
| 147 | |||
| 148 | /** |
||
| 149 | * @return \yii\db\ActiveQuery |
||
| 150 | */ |
||
| 151 | 8 | public function getChildren() |
|
| 155 | |||
| 156 | /** |
||
| 157 | * @param int|null $depth |
||
| 158 | * @return \yii\db\ActiveQuery |
||
| 159 | */ |
||
| 160 | 3 | public function getLeaves($depth = null) |
|
| 164 | |||
| 165 | /** |
||
| 166 | * @return \yii\db\ActiveQuery |
||
| 167 | * @throws \yii\base\NotSupportedException |
||
| 168 | */ |
||
| 169 | 3 | public function getPrev() |
|
| 173 | |||
| 174 | /** |
||
| 175 | * @return \yii\db\ActiveQuery |
||
| 176 | * @throws \yii\base\NotSupportedException |
||
| 177 | */ |
||
| 178 | 3 | public function getNext() |
|
| 182 | |||
| 183 | /** |
||
| 184 | * Populate children relations for self and all descendants |
||
| 185 | * @param int $depth = null |
||
| 186 | * @return self |
||
| 187 | */ |
||
| 188 | public function populateTree($depth = null) |
||
| 192 | |||
| 193 | /** |
||
| 194 | * @return bool |
||
| 195 | */ |
||
| 196 | 12 | public function isRoot() |
|
| 200 | |||
| 201 | /** |
||
| 202 | * @param \yii\db\BaseActiveRecord $node |
||
| 203 | * @return bool |
||
| 204 | */ |
||
| 205 | 17 | public function isChildOf($node) |
|
| 209 | |||
| 210 | /** |
||
| 211 | * @return bool |
||
| 212 | */ |
||
| 213 | 3 | public function isLeaf() |
|
| 217 | |||
| 218 | /** |
||
| 219 | * @return $this |
||
| 220 | */ |
||
| 221 | 6 | public function makeRoot() |
|
| 225 | |||
| 226 | /** |
||
| 227 | * @param \yii\db\BaseActiveRecord $node |
||
| 228 | * @return $this |
||
| 229 | */ |
||
| 230 | 6 | public function prependTo($node) |
|
| 234 | |||
| 235 | /** |
||
| 236 | * @param \yii\db\BaseActiveRecord $node |
||
| 237 | * @return $this |
||
| 238 | */ |
||
| 239 | 3 | public function appendTo($node) |
|
| 243 | |||
| 244 | /** |
||
| 245 | * @param \yii\db\BaseActiveRecord $node |
||
| 246 | * @return $this |
||
| 247 | */ |
||
| 248 | 3 | public function insertBefore($node) |
|
| 252 | |||
| 253 | /** |
||
| 254 | * @param \yii\db\BaseActiveRecord $node |
||
| 255 | * @return $this |
||
| 256 | */ |
||
| 257 | 6 | public function insertAfter($node) |
|
| 261 | |||
| 262 | /** |
||
| 263 | * @return bool|int |
||
| 264 | * @throws \Exception |
||
| 265 | * @throws \yii\db\Exception |
||
| 266 | */ |
||
| 267 | 3 | public function deleteWithChildren() |
|
| 273 | } |
Loading history...
This check looks for methods that are used by a trait but not required by it.
To illustrate, let’s look at the following code example
The trait
Idableprovides a methodequalsIdthat in turn relies on the methodgetId(). If this method does not exist on a class mixing in this trait, the method will fail.Adding the
getId()as an abstract method to the trait will make sure it is available.