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 |
||
42 | class Controller extends ApiController |
||
43 | { |
||
44 | |||
45 | /** |
||
46 | * @param \App\Containers\Authorization\UI\API\Requests\ListAllPermissionsRequest $request |
||
47 | * @param \App\Containers\Authorization\Actions\ListAllPermissionsAction $action |
||
48 | * |
||
49 | * @return \Dingo\Api\Http\Response |
||
50 | */ |
||
51 | public function listAllPermissions(ListAllPermissionsRequest $request, ListAllPermissionsAction $action) |
||
52 | { |
||
53 | $permissions = $action->run(); |
||
54 | |||
55 | return $this->response->collection($permissions, new PermissionTransformer()); |
||
56 | } |
||
57 | |||
58 | /** |
||
59 | * @param \App\Containers\Authorization\UI\API\Requests\GetPermissionRequest $request |
||
60 | * @param \App\Containers\Authorization\Actions\GetPermissionAction $action |
||
61 | * |
||
62 | * @return \Dingo\Api\Http\Response |
||
63 | */ |
||
64 | public function getPermission(GetPermissionRequest $request, GetPermissionAction $action) |
||
65 | { |
||
66 | $permission = $action->run($request['id']); |
||
67 | |||
68 | return $this->response->item($permission, new PermissionTransformer()); |
||
69 | } |
||
70 | |||
71 | /** |
||
72 | * @param \App\Containers\Authorization\UI\API\Requests\ListAllRolesRequest $request |
||
73 | * @param \App\Containers\Authorization\Actions\ListAllRolesAction $action |
||
74 | * |
||
75 | * @return \Dingo\Api\Http\Response |
||
76 | */ |
||
77 | public function listAllRoles(ListAllRolesRequest $request, ListAllRolesAction $action) |
||
78 | { |
||
79 | $roles = $action->run(); |
||
80 | |||
81 | return $this->response->collection($roles, new RoleTransformer()); |
||
82 | } |
||
83 | |||
84 | /** |
||
85 | * @param \App\Containers\Authorization\UI\API\Requests\GetRoleRequest $request |
||
86 | * @param \App\Containers\Authorization\Actions\GetRoleAction $action |
||
87 | * |
||
88 | * @return \Dingo\Api\Http\Response |
||
89 | */ |
||
90 | public function getRole(GetRoleRequest $request, GetRoleAction $action) |
||
91 | { |
||
92 | $role = $action->run($request['id']); |
||
93 | |||
94 | return $this->response->item($role, new RoleTransformer()); |
||
95 | } |
||
96 | |||
97 | /** |
||
98 | * @param \App\Containers\Authorization\UI\API\Requests\AssignUserToRoleRequest $request |
||
99 | * @param \App\Containers\Authorization\Actions\AssignUserToRoleAction $action |
||
100 | * |
||
101 | * @return \Dingo\Api\Http\Response |
||
102 | */ |
||
103 | public function assignUserToRole(AssignUserToRoleRequest $request, AssignUserToRoleAction $action) |
||
104 | { |
||
105 | $user = $action->run($request['user_id'], $request['roles_ids']); |
||
106 | |||
107 | return $this->response->item($user, new UserTransformer()); |
||
108 | } |
||
109 | |||
110 | /** |
||
111 | * @param \App\Containers\Authorization\UI\API\Requests\SyncUserRolesRequest $request |
||
112 | * @param \App\Containers\Authorization\Actions\SyncUserRolesAction $action |
||
113 | * |
||
114 | * @return \Dingo\Api\Http\Response |
||
115 | */ |
||
116 | public function syncUserRoles(SyncUserRolesRequest $request, SyncUserRolesAction $action) |
||
122 | |||
123 | /** |
||
124 | * @param \App\Containers\Authorization\UI\API\Requests\DeleteRoleRequest $request |
||
125 | * @param \App\Containers\Authorization\Actions\DeleteRoleAction $action |
||
126 | * |
||
127 | * @return \Dingo\Api\Http\Response |
||
128 | */ |
||
129 | View Code Duplication | public function deleteRole(DeleteRoleRequest $request, DeleteRoleAction $action) |
|
137 | |||
138 | /** |
||
139 | * @param \App\Containers\Authorization\UI\API\Requests\RevokeUserFromRoleRequest $request |
||
140 | * @param \App\Containers\Authorization\Actions\RevokeUserFromRoleAction $action |
||
141 | * |
||
142 | * @return \Dingo\Api\Http\Response |
||
143 | */ |
||
144 | public function revokeRoleFromUser(RevokeUserFromRoleRequest $request, RevokeUserFromRoleAction $action) |
||
150 | |||
151 | /** |
||
152 | * @param \App\Containers\Authorization\UI\API\Requests\AttachPermissionToRoleRequest $request |
||
153 | * @param \App\Containers\Authorization\Actions\AttachPermissionsToRoleAction $action |
||
154 | * |
||
155 | * @return \Dingo\Api\Http\Response |
||
156 | */ |
||
157 | public function attachPermissionToRole( |
||
158 | AttachPermissionToRoleRequest $request, |
||
159 | AttachPermissionsToRoleAction $action |
||
160 | ) { |
||
161 | $role = $action->run($request['role_id'], $request['permissions_ids']); |
||
162 | |||
163 | return $this->response->item($role, new RoleTransformer()); |
||
164 | } |
||
165 | |||
166 | /** |
||
167 | * @param \App\Containers\Authorization\UI\API\Requests\SyncPermissionsOnRoleRequest $request |
||
168 | * @param \App\Containers\Authorization\Actions\SyncPermissionsOnRoleAction $action |
||
169 | * |
||
170 | * @return \Dingo\Api\Http\Response |
||
171 | */ |
||
172 | public function syncPermissionOnRole( |
||
180 | |||
181 | /** |
||
182 | * @param \App\Containers\Authorization\UI\API\Requests\DetachPermissionToRoleRequest $request |
||
183 | * @param \App\Containers\Authorization\Actions\DetachPermissionsFromRoleAction $action |
||
184 | * |
||
185 | * @return \Dingo\Api\Http\Response |
||
186 | */ |
||
187 | public function detachPermissionFromRole( |
||
195 | |||
196 | /** |
||
197 | * @param \App\Containers\Authorization\UI\API\Requests\CreateRoleRequest $request |
||
198 | * @param \App\Containers\Authorization\Actions\CreateRoleAction $action |
||
199 | * |
||
200 | * @return \Dingo\Api\Http\Response |
||
201 | */ |
||
202 | public function createRole(CreateRoleRequest $request, CreateRoleAction $action) |
||
208 | |||
209 | /** |
||
210 | * @param \App\Containers\Authorization\UI\API\Requests\CreatePermissionRequest $request |
||
211 | * @param \App\Containers\Authorization\Actions\CreatePermissionAction $action |
||
212 | * |
||
213 | * @return \Dingo\Api\Http\Response |
||
214 | */ |
||
215 | public function createPermission(CreatePermissionRequest $request, CreatePermissionAction $action) |
||
221 | |||
222 | |||
223 | } |
||
224 |
Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.
You can also find more detailed suggestions in the “Code” section of your repository.