Complex classes like Project 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 Project, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
29 | class Project |
||
30 | { |
||
31 | /** |
||
32 | * URL to check for updates, if a given project doesn't define its own. |
||
33 | */ |
||
34 | const UPDATE_DEFAULT_URL = 'http://updates.drupal.org/release-history'; |
||
35 | |||
36 | /** |
||
37 | * |
||
38 | */ |
||
39 | const INSTALL_TYPE_OFFICIAL = 'official'; |
||
40 | |||
41 | /** |
||
42 | * |
||
43 | */ |
||
44 | const INSTALL_TYPE_DEV = 'dev'; |
||
45 | |||
46 | /** |
||
47 | * |
||
48 | */ |
||
49 | const INSTALL_TYPE_UNKNOWN = 'unknown'; |
||
50 | |||
51 | /** |
||
52 | * |
||
53 | */ |
||
54 | const TYPE_PROJECT_DISTRIBUTION = 'project_distribution'; |
||
55 | |||
56 | /** |
||
57 | * |
||
58 | */ |
||
59 | const TYPE_PROJECT_CORE = 'project_core'; |
||
60 | |||
61 | /** |
||
62 | * |
||
63 | */ |
||
64 | const TYPE_PROJECT_MODULE = 'project_module'; |
||
65 | |||
66 | /** |
||
67 | * |
||
68 | */ |
||
69 | const TYPE_PROJECT_THEME = 'project_theme'; |
||
70 | |||
71 | /** |
||
72 | * |
||
73 | */ |
||
74 | const TYPE_UNKNOWN = 'unknown'; |
||
75 | |||
76 | /** |
||
77 | * @var |
||
78 | */ |
||
79 | protected $project; |
||
80 | |||
81 | /** |
||
82 | * @var string |
||
83 | */ |
||
84 | protected $filename; |
||
85 | |||
86 | /** |
||
87 | * @var |
||
88 | */ |
||
89 | protected $name; |
||
90 | |||
91 | /** |
||
92 | * @var |
||
93 | */ |
||
94 | protected $core; |
||
95 | |||
96 | /** |
||
97 | * @var |
||
98 | */ |
||
99 | protected $version; |
||
100 | |||
101 | /** |
||
102 | * @var |
||
103 | */ |
||
104 | protected $status_url; |
||
105 | |||
106 | /** |
||
107 | * @var |
||
108 | */ |
||
109 | protected $install_type; |
||
110 | |||
111 | /** |
||
112 | * @var |
||
113 | */ |
||
114 | protected $existing_version; |
||
115 | |||
116 | /** |
||
117 | * @var |
||
118 | */ |
||
119 | protected $existing_major; |
||
120 | |||
121 | /** |
||
122 | * @var array |
||
123 | */ |
||
124 | protected $data; |
||
125 | |||
126 | // Calculated properties. |
||
127 | |||
128 | /** |
||
129 | * @var |
||
130 | */ |
||
131 | protected $status; |
||
132 | |||
133 | /** |
||
134 | * @var |
||
135 | */ |
||
136 | protected $project_status; |
||
137 | |||
138 | /** |
||
139 | * @var string |
||
140 | */ |
||
141 | protected $project_type; |
||
142 | |||
143 | /** |
||
144 | * @var |
||
145 | */ |
||
146 | protected $reason; |
||
147 | |||
148 | /** |
||
149 | * @var |
||
150 | */ |
||
151 | protected $fetch_status; |
||
152 | |||
153 | /** |
||
154 | * @var |
||
155 | */ |
||
156 | protected $latest_version; |
||
157 | |||
158 | /** |
||
159 | * @var |
||
160 | */ |
||
161 | protected $latest_dev; |
||
162 | |||
163 | /** |
||
164 | * @var |
||
165 | */ |
||
166 | protected $dev_version; |
||
167 | |||
168 | /** |
||
169 | * @var |
||
170 | */ |
||
171 | protected $recommended; |
||
172 | |||
173 | /** |
||
174 | * @var |
||
175 | */ |
||
176 | protected $datestamp; |
||
177 | |||
178 | /** |
||
179 | * @var array |
||
180 | */ |
||
181 | protected $releases; |
||
182 | |||
183 | /** |
||
184 | * @var array |
||
185 | */ |
||
186 | protected $security_updates; |
||
187 | |||
188 | /** |
||
189 | * @var array |
||
190 | */ |
||
191 | protected $also_available; |
||
192 | |||
193 | /** |
||
194 | * @param string $project |
||
195 | * @param string $core |
||
196 | * @param string $version |
||
197 | */ |
||
198 | public function __construct($project, $core, $version) |
||
213 | |||
214 | /** |
||
215 | * @return string |
||
216 | */ |
||
217 | public function getFilename() |
||
221 | |||
222 | /** |
||
223 | * @param string $filename |
||
224 | */ |
||
225 | public function setFilename($filename) |
||
231 | |||
232 | /** |
||
233 | * |
||
234 | */ |
||
235 | protected function init() |
||
285 | |||
286 | /** |
||
287 | * @param string $version |
||
288 | * @param Release $release |
||
289 | */ |
||
290 | public function addSecurityUpdate($version, $release) |
||
294 | |||
295 | /** |
||
296 | * @param string $version_major |
||
297 | * @param string $version |
||
298 | */ |
||
299 | public function addAlsoAvailable($version_major, $version) |
||
303 | |||
304 | /** |
||
305 | * @return array |
||
306 | */ |
||
307 | public function getAlsoAvailable() |
||
311 | |||
312 | /** |
||
313 | * @param string $version_major |
||
314 | * @return bool |
||
315 | */ |
||
316 | public function hasAlsoAvailable($version_major) |
||
320 | |||
321 | /** |
||
322 | * @return mixed |
||
323 | */ |
||
324 | public function getCore() |
||
328 | |||
329 | /** |
||
330 | * @return mixed |
||
331 | */ |
||
332 | public function getDatestamp() |
||
336 | |||
337 | /** |
||
338 | * @return array |
||
339 | */ |
||
340 | public function getDetails() |
||
344 | |||
345 | /** |
||
346 | * @return string |
||
347 | */ |
||
348 | public function getProjectType() |
||
352 | |||
353 | /** |
||
354 | * @param string $type |
||
355 | */ |
||
356 | public function setProjectType($type) |
||
360 | |||
361 | /** |
||
362 | * @return mixed |
||
363 | */ |
||
364 | public function getDevVersion() |
||
368 | |||
369 | /** |
||
370 | * @param $dev_version |
||
371 | */ |
||
372 | public function setDevVersion($dev_version) |
||
376 | |||
377 | /** |
||
378 | * @return string |
||
379 | */ |
||
380 | public function getExistingMajor() |
||
384 | |||
385 | /** |
||
386 | * @return string |
||
387 | */ |
||
388 | public function getExistingVersion() |
||
392 | |||
393 | /** |
||
394 | * @return integer |
||
395 | */ |
||
396 | public function getFetchStatus() |
||
400 | |||
401 | /** |
||
402 | * @param $fetch_status |
||
403 | */ |
||
404 | public function setFetchStatus($fetch_status) |
||
408 | |||
409 | /** |
||
410 | * @return string |
||
411 | */ |
||
412 | public function getInstallType() |
||
416 | |||
417 | /** |
||
418 | * @return mixed |
||
419 | */ |
||
420 | public function getLatestDev() |
||
424 | |||
425 | /** |
||
426 | * @param $latest_dev |
||
427 | */ |
||
428 | public function setLatestDev($latest_dev) |
||
432 | |||
433 | /** |
||
434 | * @return mixed |
||
435 | */ |
||
436 | public function getLatestVersion() |
||
440 | |||
441 | /** |
||
442 | * @param $latest_version |
||
443 | */ |
||
444 | public function setLatestVersion($latest_version) |
||
448 | |||
449 | /** |
||
450 | * @return string |
||
451 | */ |
||
452 | public function getName() |
||
456 | |||
457 | /** |
||
458 | * @return string |
||
459 | */ |
||
460 | public function getProject() |
||
464 | |||
465 | /** |
||
466 | * @return int |
||
467 | */ |
||
468 | public function getProjectStatus() |
||
472 | |||
473 | /** |
||
474 | * @param int $project_status |
||
475 | */ |
||
476 | public function setProjectStatus($project_status) |
||
480 | |||
481 | /** |
||
482 | * @return string |
||
483 | */ |
||
484 | public function getReason() |
||
488 | |||
489 | /** |
||
490 | * @param string $reason |
||
491 | */ |
||
492 | public function setReason($reason) |
||
496 | |||
497 | /** |
||
498 | * @return mixed |
||
499 | */ |
||
500 | public function getRecommended() |
||
504 | |||
505 | /** |
||
506 | * @param $recommended |
||
507 | */ |
||
508 | public function setRecommended($recommended) |
||
512 | |||
513 | /** |
||
514 | * @return Release[] |
||
515 | */ |
||
516 | public function getReleases() |
||
520 | |||
521 | /** |
||
522 | * @param Release[] $releases |
||
523 | */ |
||
524 | public function setReleases($releases) |
||
528 | |||
529 | /** |
||
530 | * @param string $release |
||
531 | * |
||
532 | * @return Release|false |
||
533 | */ |
||
534 | public function getRelease($release) |
||
542 | |||
543 | /** |
||
544 | * @return Release[] |
||
545 | */ |
||
546 | public function getSecurityUpdates() |
||
550 | |||
551 | /** |
||
552 | * @param Release[] $security_updates |
||
553 | */ |
||
554 | public function setSecurityUpdates($security_updates) |
||
558 | |||
559 | /** |
||
560 | * @return int |
||
561 | */ |
||
562 | public function getStatus() |
||
566 | |||
567 | /** |
||
568 | * @param int $status |
||
569 | */ |
||
570 | public function setStatus($status) |
||
574 | |||
575 | /** |
||
576 | * @return string |
||
577 | */ |
||
578 | public function getStatusUrl() |
||
582 | |||
583 | /** |
||
584 | * @param string $status_url |
||
585 | */ |
||
586 | public function setStatusUrl($status_url) |
||
590 | |||
591 | /** |
||
592 | * @return string |
||
593 | */ |
||
594 | public function getVersion() |
||
598 | |||
599 | /** |
||
600 | * @return bool |
||
601 | */ |
||
602 | public function hasSecurityUpdates() |
||
606 | |||
607 | /** |
||
608 | * @param array $data |
||
609 | */ |
||
610 | public function setDetails($data) |
||
622 | |||
623 | /** |
||
624 | * @param string $version |
||
625 | * @param Release $release |
||
626 | */ |
||
627 | public function setRelease($version, Release $release) |
||
631 | } |
||
632 |