Complex classes like UserModel 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 UserModel, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
22 | class UserModel extends AbstractModel |
||
23 | { |
||
24 | /** |
||
25 | * @var string |
||
26 | */ |
||
27 | public static $endpoint = '/users'; |
||
28 | |||
29 | /** |
||
30 | * @param array $requestOptions |
||
31 | * @return ResponseInterface |
||
32 | */ |
||
33 | public function loginToUserAccount(array $requestOptions) |
||
37 | |||
38 | /** |
||
39 | * @return ResponseInterface |
||
40 | */ |
||
41 | public function logoutOfUserAccount() |
||
45 | |||
46 | /** |
||
47 | * @return ResponseInterface |
||
48 | */ |
||
49 | public function getAuthenticatedUser() |
||
53 | |||
54 | /** |
||
55 | * @param array $requestOptions |
||
56 | * @return ResponseInterface |
||
57 | */ |
||
58 | public function createUser(array $requestOptions) |
||
62 | |||
63 | /** |
||
64 | * @param array $requestOptions |
||
65 | * @return ResponseInterface |
||
66 | */ |
||
67 | public function getUsers(array $requestOptions) |
||
71 | |||
72 | /** |
||
73 | * @param array $requestOptions |
||
74 | * @return ResponseInterface |
||
75 | */ |
||
76 | public function getUsersByIds(array $requestOptions) |
||
80 | |||
81 | /** |
||
82 | * @param array $requestOptions |
||
83 | * @return ResponseInterface |
||
84 | */ |
||
85 | public function searchUsers(array $requestOptions) |
||
89 | |||
90 | /** |
||
91 | * @param array $requestOptions |
||
92 | * @return ResponseInterface |
||
93 | */ |
||
94 | public function autocompleteUsers(array $requestOptions) |
||
98 | |||
99 | /** |
||
100 | * @param $userId |
||
101 | * @return ResponseInterface |
||
102 | */ |
||
103 | public function getUser($userId) |
||
107 | |||
108 | /** |
||
109 | * @param $userId |
||
110 | * @param array $requestOptions |
||
111 | * @return ResponseInterface |
||
112 | */ |
||
113 | public function updateUser($userId, array $requestOptions) |
||
117 | |||
118 | /** |
||
119 | * @param $userId |
||
120 | * @return ResponseInterface |
||
121 | */ |
||
122 | public function deactivateUserAccount($userId) |
||
126 | |||
127 | /** |
||
128 | * @param $userId |
||
129 | * @param array $requestOptions |
||
130 | * @return ResponseInterface |
||
131 | */ |
||
132 | public function patchUser($userId, array $requestOptions) |
||
136 | |||
137 | /** |
||
138 | * @param $userId |
||
139 | * @param array $requestOptions |
||
140 | * @return ResponseInterface |
||
141 | */ |
||
142 | public function updateUserRoles($userId, array $requestOptions) |
||
146 | |||
147 | /** |
||
148 | * @param $userId |
||
149 | * @param array $requestOptions |
||
150 | * @return ResponseInterface |
||
151 | */ |
||
152 | public function updateUserActive($userId, array $requestOptions) |
||
156 | |||
157 | /** |
||
158 | * @param $userId |
||
159 | * @return ResponseInterface |
||
160 | */ |
||
161 | public function getUserProfileImage($userId) |
||
165 | |||
166 | /** |
||
167 | * @param $userId |
||
168 | * @param array $requestOptions |
||
169 | * @return ResponseInterface |
||
170 | */ |
||
171 | public function setUserProfileImage($userId, array $requestOptions) |
||
175 | |||
176 | /** |
||
177 | * @param $userId |
||
178 | * @return ResponseInterface |
||
179 | */ |
||
180 | public function deleteUserProfileImage($userId) |
||
184 | |||
185 | /** |
||
186 | * @param $userId |
||
187 | * @return ResponseInterface |
||
188 | */ |
||
189 | public function returnUserDefaultProfileImage($userId) |
||
193 | |||
194 | /** |
||
195 | * @param $username |
||
196 | * @return ResponseInterface |
||
197 | */ |
||
198 | public function getUserByUsername($username) |
||
202 | |||
203 | /** |
||
204 | * @param $requestOptions |
||
205 | * @return ResponseInterface |
||
206 | */ |
||
207 | public function getUsersByUsernames(array $requestOptions) |
||
211 | |||
212 | /** |
||
213 | * @param array $requestOptions |
||
214 | * @return ResponseInterface |
||
215 | */ |
||
216 | public function resetPassword(array $requestOptions) |
||
220 | |||
221 | /** |
||
222 | * @param $userId |
||
223 | * @param array $requestOptions |
||
224 | * @return ResponseInterface |
||
225 | */ |
||
226 | public function updateUserMfa($userId, array $requestOptions) |
||
230 | |||
231 | /** |
||
232 | * @param $userId |
||
233 | * @param array $requestOptions |
||
234 | * @return ResponseInterface |
||
235 | */ |
||
236 | public function generateMfaSecret($userId, array $requestOptions) |
||
240 | |||
241 | /** |
||
242 | * @param array $requestOptions |
||
243 | * @return ResponseInterface |
||
244 | */ |
||
245 | public function checkMfa(array $requestOptions) |
||
249 | |||
250 | /** |
||
251 | * @param $userId |
||
252 | * @param array $requestOptions |
||
253 | * @return ResponseInterface |
||
254 | */ |
||
255 | public function updateUserPassword($userId, array $requestOptions) |
||
259 | |||
260 | /** |
||
261 | * @param array $requestOptions |
||
262 | * @return ResponseInterface |
||
263 | */ |
||
264 | public function sendPasswordResetEmail(array $requestOptions) |
||
268 | |||
269 | /** |
||
270 | * @param $email |
||
271 | * @return ResponseInterface |
||
272 | */ |
||
273 | public function getUserByEmail($email) |
||
277 | |||
278 | /** |
||
279 | * @param $userId |
||
280 | * @return ResponseInterface |
||
281 | */ |
||
282 | public function getUserSessions($userId) |
||
286 | |||
287 | /** |
||
288 | * @param $userId |
||
289 | * @param array $requestOptions |
||
290 | * @return ResponseInterface |
||
291 | */ |
||
292 | public function revokeUserSession($userId, array $requestOptions) |
||
296 | |||
297 | /** |
||
298 | * @param $userId |
||
299 | * @return ResponseInterface |
||
300 | */ |
||
301 | public function revokeAllUserSessions($userId) |
||
305 | |||
306 | /** |
||
307 | * @param array $requestOptions |
||
308 | * @return ResponseInterface |
||
309 | */ |
||
310 | public function attachMobileDevice(array $requestOptions) |
||
314 | |||
315 | /** |
||
316 | * @param $userId |
||
317 | * @return ResponseInterface |
||
318 | */ |
||
319 | public function getUserAudits($userId) |
||
323 | |||
324 | /** |
||
325 | * @param array $requestOptions |
||
326 | * @return ResponseInterface |
||
327 | */ |
||
328 | public function verifyUserEmail(array $requestOptions) |
||
332 | |||
333 | /** |
||
334 | * @param array $requestOptions |
||
335 | * @return ResponseInterface |
||
336 | */ |
||
337 | public function sendVerificationEmail(array $requestOptions) |
||
341 | |||
342 | /** |
||
343 | * @param array $requestOptions |
||
344 | * @return ResponseInterface |
||
345 | */ |
||
346 | public function switchLoginMethod(array $requestOptions) |
||
350 | |||
351 | /** |
||
352 | * @param $userId |
||
353 | * @param array $requestOptions |
||
354 | * @return ResponseInterface |
||
355 | */ |
||
356 | public function createToken($userId, array $requestOptions) |
||
360 | |||
361 | /** |
||
362 | * @param $userId |
||
363 | * @param array $requestOptions |
||
364 | * @return ResponseInterface |
||
365 | */ |
||
366 | public function getTokens($userId, array $requestOptions) |
||
370 | |||
371 | /** |
||
372 | * @param $tokenId |
||
373 | * @return ResponseInterface |
||
374 | */ |
||
375 | public function getToken($tokenId) |
||
379 | |||
380 | /** |
||
381 | * @param array $requestOptions |
||
382 | * @return ResponseInterface |
||
383 | */ |
||
384 | public function revokeToken(array $requestOptions) |
||
388 | |||
389 | /** |
||
390 | * @param array $requestOptions |
||
391 | * @return ResponseInterface |
||
392 | */ |
||
393 | public function disablePersonalAccessToken(array $requestOptions) |
||
397 | |||
398 | /** |
||
399 | * @param array $requestOptions |
||
400 | * @return ResponseInterface |
||
401 | */ |
||
402 | public function enablePersonalAccessToken(array $requestOptions) |
||
406 | |||
407 | /** |
||
408 | * @param array $requestOptions |
||
409 | * @return ResponseInterface |
||
410 | */ |
||
411 | public function searchTokens(array $requestOptions) |
||
415 | |||
416 | /** |
||
417 | * @param $userId |
||
418 | * @return ResponseInterface |
||
419 | */ |
||
420 | public function getUserStatus($userId) |
||
424 | |||
425 | /** |
||
426 | * @param $userId |
||
427 | * @param array $requestOptions |
||
428 | * @return ResponseInterface |
||
429 | */ |
||
430 | public function updateUserStatus($userId, array $requestOptions) |
||
434 | |||
435 | /** |
||
436 | * @param $userId |
||
437 | * @param array $requestOptions |
||
438 | * @return ResponseInterface |
||
439 | */ |
||
440 | public function updateUserAuthenticationMethod($userId, array $requestOptions) |
||
444 | |||
445 | /** |
||
446 | * @return ResponseInterface |
||
447 | */ |
||
448 | public function getTotalCountOfUsersInTheSystem() |
||
452 | } |
||
453 |