hiqdev /
hipanel-rbac
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 |
||
| 22 | trait SetterTrait |
||
| 23 | { |
||
| 24 | /** |
||
| 25 | * Set permission. |
||
| 26 | * @param string $name |
||
| 27 | * @param string $description |
||
| 28 | * @return Item |
||
| 29 | 5 | */ |
|
| 30 | public function setPermission($name, $description = null) |
||
| 31 | 5 | { |
|
| 32 | 5 | $permission = $this->getPermission($name) ?: $this->createPermission($name); |
|
| 33 | if ($description) { |
||
| 34 | $permission->description = $description; |
||
| 35 | 5 | } |
|
| 36 | $this->add($permission); |
||
| 37 | 5 | ||
| 38 | return $permission; |
||
| 39 | } |
||
| 40 | |||
| 41 | /** |
||
| 42 | * Set role. |
||
| 43 | * @param string $name |
||
| 44 | * @param string $description |
||
| 45 | * @return Item |
||
| 46 | 5 | */ |
|
| 47 | public function setRole($name, $description = null) |
||
| 48 | 5 | { |
|
| 49 | 5 | $role = $this->getRole($name) ?: $this->createRole($name); |
|
| 50 | if ($description) { |
||
| 51 | $role->description = $description; |
||
| 52 | 5 | } |
|
| 53 | $this->add($role); |
||
| 54 | 5 | ||
| 55 | return $role; |
||
| 56 | } |
||
| 57 | |||
| 58 | /** |
||
| 59 | * Set child. |
||
| 60 | * @param string|Item $parent |
||
| 61 | * @param string|Item $child |
||
| 62 | * @return bool |
||
| 63 | 5 | */ |
|
| 64 | public function setChild($parent, $child) |
||
| 65 | 5 | { |
|
| 66 | 5 | View Code Duplication | if (is_string($parent)) { |
| 67 | 5 | $name = $parent; |
|
| 68 | 5 | $parent = $this->getItem($parent); |
|
| 69 | if (is_null($parent)) { |
||
| 70 | throw new InvalidParamException("Unknown parent:$name at setChild"); |
||
| 71 | 5 | } |
|
| 72 | 5 | } |
|
| 73 | 5 | View Code Duplication | if (is_string($child)) { |
| 74 | 5 | $name = $child; |
|
| 75 | 5 | $child = $this->getItem($child); |
|
| 76 | if (is_null($child)) { |
||
| 77 | throw new InvalidParamException("Unknown child:$name at setChild"); |
||
| 78 | 5 | } |
|
| 79 | 5 | } |
|
| 80 | if (isset($this->children[$parent->name][$child->name])) { |
||
| 81 | return false; |
||
| 82 | } |
||
| 83 | 5 | ||
| 84 | return $this->addChild($parent, $child); |
||
| 85 | } |
||
| 86 | |||
| 87 | /** |
||
| 88 | * Assigns an item (role or permission) to a user. |
||
| 89 | * @param string|Item $item |
||
| 90 | * @param string|integer $userId the user ID (see [[\yii\web\User::id]]) |
||
| 91 | * @throws \Exception when given wrong item name |
||
| 92 | * @return Assignment the assignment object |
||
| 93 | 10 | */ |
|
| 94 | public function setAssignment($item, $userId) |
||
| 109 | |||
| 110 | /** |
||
| 111 | * Assigns items to a user. |
||
| 112 | * @param string|array $items |
||
| 113 | * @param string|integer $userId |
||
| 114 | 2 | */ |
|
| 115 | public function setAssignments($items, $userId) |
||
| 124 | |||
| 125 | /** |
||
| 126 | * Returns all assignments in the system. |
||
| 127 | * @return array |
||
| 128 | */ |
||
| 129 | public function getAllAssignments() |
||
| 133 | |||
| 134 | /** |
||
| 135 | * Returns all items in the system. |
||
| 136 | * @return array |
||
| 137 | 10 | */ |
|
| 138 | public function getAllItems() |
||
| 142 | } |
||
| 143 |
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.