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 |
||
21 | class UserModel extends AbstractModel |
||
22 | { |
||
23 | /** |
||
24 | * @var string |
||
25 | */ |
||
26 | public static $endpoint = '/users'; |
||
27 | |||
28 | /** |
||
29 | * @param array $requestOptions |
||
30 | * @return \Psr\Http\Message\ResponseInterface |
||
31 | */ |
||
32 | public function loginToUserAccount(array $requestOptions) |
||
36 | |||
37 | /** |
||
38 | * @return \Psr\Http\Message\ResponseInterface |
||
39 | */ |
||
40 | public function logoutOfUserAccount() |
||
44 | |||
45 | /** |
||
46 | * @return \Psr\Http\Message\ResponseInterface |
||
47 | */ |
||
48 | public function getAuthenticatedUser() |
||
52 | |||
53 | /** |
||
54 | * @param array $requestOptions |
||
55 | * @return \Psr\Http\Message\ResponseInterface |
||
56 | */ |
||
57 | public function createUser(array $requestOptions) |
||
61 | |||
62 | /** |
||
63 | * @param array $requestOptions |
||
64 | * @return \Psr\Http\Message\ResponseInterface |
||
65 | */ |
||
66 | public function getUsers(array $requestOptions) |
||
70 | |||
71 | /** |
||
72 | * @param array $requestOptions |
||
73 | * @return \Psr\Http\Message\ResponseInterface |
||
74 | */ |
||
75 | public function getUsersByIds(array $requestOptions) |
||
79 | |||
80 | /** |
||
81 | * @param array $requestOptions |
||
82 | * @return \Psr\Http\Message\ResponseInterface |
||
83 | */ |
||
84 | public function searchUsers(array $requestOptions) |
||
88 | |||
89 | /** |
||
90 | * @param array $requestOptions |
||
91 | * @return \Psr\Http\Message\ResponseInterface |
||
92 | */ |
||
93 | public function autocompleteUsers(array $requestOptions) |
||
97 | |||
98 | /** |
||
99 | * @param $userId |
||
100 | * @return \Psr\Http\Message\ResponseInterface |
||
101 | */ |
||
102 | public function getUser($userId) |
||
106 | |||
107 | /** |
||
108 | * @param $userId |
||
109 | * @param array $requestOptions |
||
110 | * @return \Psr\Http\Message\ResponseInterface |
||
111 | */ |
||
112 | public function updateUser($userId, array $requestOptions) |
||
116 | |||
117 | /** |
||
118 | * @param $userId |
||
119 | * @return \Psr\Http\Message\ResponseInterface |
||
120 | */ |
||
121 | public function deactivateUserAccount($userId) |
||
125 | |||
126 | /** |
||
127 | * @param $userId |
||
128 | * @param array $requestOptions |
||
129 | * @return \Psr\Http\Message\ResponseInterface |
||
130 | */ |
||
131 | public function patchUser($userId, array $requestOptions) |
||
135 | |||
136 | /** |
||
137 | * @param $userId |
||
138 | * @param array $requestOptions |
||
139 | * @return \Psr\Http\Message\ResponseInterface |
||
140 | */ |
||
141 | public function updateUserRoles($userId, array $requestOptions) |
||
145 | |||
146 | /** |
||
147 | * @param $userId |
||
148 | * @param array $requestOptions |
||
149 | * @return \Psr\Http\Message\ResponseInterface |
||
150 | */ |
||
151 | public function updateUserActive($userId, array $requestOptions) |
||
155 | |||
156 | /** |
||
157 | * @param $userId |
||
158 | * @return \Psr\Http\Message\ResponseInterface |
||
159 | */ |
||
160 | public function getUserProfileImage($userId) |
||
164 | |||
165 | /** |
||
166 | * @param $userId |
||
167 | * @param array $requestOptions |
||
168 | * @return \Psr\Http\Message\ResponseInterface |
||
169 | */ |
||
170 | public function setUserProfileImage($userId, array $requestOptions) |
||
174 | |||
175 | /** |
||
176 | * @param $username |
||
177 | * @return \Psr\Http\Message\ResponseInterface |
||
178 | */ |
||
179 | public function getUserByUsername($username) |
||
183 | |||
184 | /** |
||
185 | * @param $requestOptions |
||
186 | * @return \Psr\Http\Message\ResponseInterface |
||
187 | */ |
||
188 | public function getUsersByUsernames(array $requestOptions) |
||
192 | |||
193 | /** |
||
194 | * @param array $requestOptions |
||
195 | * @return \Psr\Http\Message\ResponseInterface |
||
196 | */ |
||
197 | public function resetPassword(array $requestOptions) |
||
201 | |||
202 | /** |
||
203 | * @param $userId |
||
204 | * @param array $requestOptions |
||
205 | * @return \Psr\Http\Message\ResponseInterface |
||
206 | */ |
||
207 | public function updateUserMfa($userId, array $requestOptions) |
||
211 | |||
212 | /** |
||
213 | * @param $userId |
||
214 | * @param array $requestOptions |
||
215 | * @return \Psr\Http\Message\ResponseInterface |
||
216 | */ |
||
217 | public function generateMfaSecret($userId, array $requestOptions) |
||
221 | |||
222 | /** |
||
223 | * @param array $requestOptions |
||
224 | * @return \Psr\Http\Message\ResponseInterface |
||
225 | */ |
||
226 | public function checkMfa(array $requestOptions) |
||
230 | |||
231 | /** |
||
232 | * @param $userId |
||
233 | * @param array $requestOptions |
||
234 | * @return \Psr\Http\Message\ResponseInterface |
||
235 | */ |
||
236 | public function updateUserPassword($userId, array $requestOptions) |
||
240 | |||
241 | /** |
||
242 | * @param array $requestOptions |
||
243 | * @return \Psr\Http\Message\ResponseInterface |
||
244 | */ |
||
245 | public function sendPasswordResetEmail(array $requestOptions) |
||
249 | |||
250 | /** |
||
251 | * @param $email |
||
252 | * @return \Psr\Http\Message\ResponseInterface |
||
253 | */ |
||
254 | public function getUserByEmail($email) |
||
258 | |||
259 | /** |
||
260 | * @param $userId |
||
261 | * @return \Psr\Http\Message\ResponseInterface |
||
262 | */ |
||
263 | public function getUserSessions($userId) |
||
267 | |||
268 | /** |
||
269 | * @param $userId |
||
270 | * @param array $requestOptions |
||
271 | * @return \Psr\Http\Message\ResponseInterface |
||
272 | */ |
||
273 | public function revokeUserSession($userId, array $requestOptions) |
||
277 | |||
278 | /** |
||
279 | * @param $userId |
||
280 | * @return \Psr\Http\Message\ResponseInterface |
||
281 | */ |
||
282 | public function revokeAllUserSessions($userId) |
||
286 | |||
287 | /** |
||
288 | * @param array $requestOptions |
||
289 | * @return \Psr\Http\Message\ResponseInterface |
||
290 | */ |
||
291 | public function attachMobileDevice(array $requestOptions) |
||
295 | |||
296 | /** |
||
297 | * @param $userId |
||
298 | * @return \Psr\Http\Message\ResponseInterface |
||
299 | */ |
||
300 | public function getUserAudits($userId) |
||
304 | |||
305 | /** |
||
306 | * @param array $requestOptions |
||
307 | * @return \Psr\Http\Message\ResponseInterface |
||
308 | */ |
||
309 | public function verifyUserEmail(array $requestOptions) |
||
313 | |||
314 | /** |
||
315 | * @param array $requestOptions |
||
316 | * @return \Psr\Http\Message\ResponseInterface |
||
317 | */ |
||
318 | public function sendVerificationEmail(array $requestOptions) |
||
322 | |||
323 | /** |
||
324 | * @param array $requestOptions |
||
325 | * @return \Psr\Http\Message\ResponseInterface |
||
326 | */ |
||
327 | public function switchLoginMethod(array $requestOptions) |
||
331 | |||
332 | /** |
||
333 | * @param $userId |
||
334 | * @param array $requestOptions |
||
335 | * @return \Psr\Http\Message\ResponseInterface |
||
336 | */ |
||
337 | public function createToken($userId, array $requestOptions) |
||
341 | |||
342 | /** |
||
343 | * @param $userId |
||
344 | * @param array $requestOptions |
||
345 | * @return \Psr\Http\Message\ResponseInterface |
||
346 | */ |
||
347 | public function getTokens($userId, array $requestOptions) |
||
351 | |||
352 | /** |
||
353 | * @param $tokenId |
||
354 | * @return \Psr\Http\Message\ResponseInterface |
||
355 | */ |
||
356 | public function getToken($tokenId) |
||
360 | |||
361 | /** |
||
362 | * @param array $requestOptions |
||
363 | * @return \Psr\Http\Message\ResponseInterface |
||
364 | */ |
||
365 | public function revokeToken(array $requestOptions) |
||
369 | |||
370 | /** |
||
371 | * @param array $requestOptions |
||
372 | * @return \Psr\Http\Message\ResponseInterface |
||
373 | */ |
||
374 | public function disablePersonalAccessToken(array $requestOptions) |
||
378 | |||
379 | /** |
||
380 | * @param array $requestOptions |
||
381 | * @return \Psr\Http\Message\ResponseInterface |
||
382 | */ |
||
383 | public function enablePersonalAccessToken(array $requestOptions) |
||
387 | |||
388 | /** |
||
389 | * @param array $requestOptions |
||
390 | * @return \Psr\Http\Message\ResponseInterface |
||
391 | */ |
||
392 | public function searchTokens(array $requestOptions) |
||
396 | |||
397 | /** |
||
398 | * @param $userId |
||
399 | * @return \Psr\Http\Message\ResponseInterface |
||
400 | */ |
||
401 | public function getUserStatus($userId) |
||
405 | |||
406 | /** |
||
407 | * @param $userId |
||
408 | * @param array $requestOptions |
||
409 | * @return \Psr\Http\Message\ResponseInterface |
||
410 | */ |
||
411 | public function updateUserStatus($userId, array $requestOptions) |
||
415 | |||
416 | /** |
||
417 | * @param $userId |
||
418 | * @param array $requestOptions |
||
419 | * @return \Psr\Http\Message\ResponseInterface |
||
420 | */ |
||
421 | public function updateUserAuthenticationMethod($userId, array $requestOptions) |
||
425 | } |
||
426 |