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 |
||
| 20 | class ProjectGroupRoleModel extends Model |
||
| 21 | { |
||
| 22 | /** |
||
| 23 | * SQL table name. |
||
| 24 | * |
||
| 25 | * @var string |
||
| 26 | */ |
||
| 27 | const TABLE = 'project_has_groups'; |
||
| 28 | |||
| 29 | /** |
||
| 30 | * Get the list of project visible by the given user according to groups. |
||
| 31 | * |
||
| 32 | * @param int $user_id |
||
| 33 | * @param array $status |
||
| 34 | * |
||
| 35 | * @return array |
||
| 36 | */ |
||
| 37 | public function getProjectsByUser($user_id, $status = [ProjectModel::ACTIVE, ProjectModel::INACTIVE]) |
||
| 47 | |||
| 48 | /** |
||
| 49 | * For a given project get the role of the specified user. |
||
| 50 | * |
||
| 51 | * @param int $project_id |
||
| 52 | * @param int $user_id |
||
| 53 | * |
||
| 54 | * @return string |
||
| 55 | */ |
||
| 56 | public function getUserRole($project_id, $user_id) |
||
| 66 | |||
| 67 | /** |
||
| 68 | * Get all groups associated directly to the project. |
||
| 69 | * |
||
| 70 | * @param int $project_id |
||
| 71 | * |
||
| 72 | * @return array |
||
| 73 | */ |
||
| 74 | public function getGroups($project_id) |
||
| 83 | |||
| 84 | /** |
||
| 85 | * From groups get all users associated to the project. |
||
| 86 | * |
||
| 87 | * @param int $project_id |
||
| 88 | * |
||
| 89 | * @return array |
||
| 90 | */ |
||
| 91 | public function getUsers($project_id) |
||
| 101 | |||
| 102 | /** |
||
| 103 | * From groups get all users assignable to tasks. |
||
| 104 | * |
||
| 105 | * @param int $project_id |
||
| 106 | * |
||
| 107 | * @return array |
||
| 108 | */ |
||
| 109 | public function getAssignableUsers($project_id) |
||
| 121 | |||
| 122 | /** |
||
| 123 | * Add a group to the project. |
||
| 124 | * |
||
| 125 | * @param int $project_id |
||
| 126 | * @param int $group_id |
||
| 127 | * @param string $role |
||
| 128 | * |
||
| 129 | * @return bool |
||
| 130 | */ |
||
| 131 | View Code Duplication | public function addGroup($project_id, $group_id, $role) |
|
| 139 | |||
| 140 | /** |
||
| 141 | * Remove a group from the project. |
||
| 142 | * |
||
| 143 | * @param int $project_id |
||
| 144 | * @param int $group_id |
||
| 145 | * |
||
| 146 | * @return bool |
||
| 147 | */ |
||
| 148 | public function removeGroup($project_id, $group_id) |
||
| 152 | |||
| 153 | /** |
||
| 154 | * Change a group role for the project. |
||
| 155 | * |
||
| 156 | * @param int $project_id |
||
| 157 | * @param int $group_id |
||
| 158 | * @param string $role |
||
| 159 | * |
||
| 160 | * @return bool |
||
| 161 | */ |
||
| 162 | View Code Duplication | public function changeGroupRole($project_id, $group_id, $role) |
|
| 171 | |||
| 172 | /** |
||
| 173 | * Copy group access from a project to another one. |
||
| 174 | * |
||
| 175 | * @param int $project_src_id Project Template |
||
| 176 | * @param int $project_dst_id Project that receives the copy |
||
| 177 | * |
||
| 178 | * @return bool |
||
| 179 | */ |
||
| 180 | View Code Duplication | public function duplicate($project_src_id, $project_dst_id) |
|
| 198 | } |
||
| 199 |
Since your code implements the magic getter
_get, this function will be called for any read access on an undefined variable. You can add the@propertyannotation to your class or interface to document the existence of this variable.If the property has read access only, you can use the @property-read annotation instead.
Of course, you may also just have mistyped another name, in which case you should fix the error.
See also the PhpDoc documentation for @property.