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:
Complex classes like Cron 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 Cron, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
8 | class Cron |
||
|
|||
9 | { |
||
10 | /** |
||
11 | * Weekday look-up table |
||
12 | * |
||
13 | * @var array |
||
14 | */ |
||
15 | protected static $weekdays = [ |
||
16 | 'sun' => 0, |
||
17 | 'mon' => 1, |
||
18 | 'tue' => 2, |
||
19 | 'wed' => 3, |
||
20 | 'thu' => 4, |
||
21 | 'fri' => 5, |
||
22 | 'sat' => 6 |
||
23 | ]; |
||
24 | |||
25 | /** |
||
26 | * Month name look-up table |
||
27 | * |
||
28 | * @var array |
||
29 | */ |
||
30 | protected static $months = [ |
||
31 | 'jan' => 1, |
||
32 | 'feb' => 2, |
||
33 | 'mar' => 3, |
||
34 | 'apr' => 4, |
||
35 | 'may' => 5, |
||
36 | 'jun' => 6, |
||
37 | 'jul' => 7, |
||
38 | 'aug' => 8, |
||
39 | 'sep' => 9, |
||
40 | 'oct' => 10, |
||
41 | 'nov' => 11, |
||
42 | 'dec' => 12 |
||
43 | ]; |
||
44 | |||
45 | /** |
||
46 | * Value boundaries |
||
47 | * |
||
48 | * @var array |
||
49 | */ |
||
50 | protected static $boundaries = [ |
||
51 | 0 => [ |
||
52 | 'min' => 0, |
||
53 | 'max' => 59 |
||
54 | ], |
||
55 | 1 => [ |
||
56 | 'min' => 0, |
||
57 | 'max' => 23 |
||
58 | ], |
||
59 | 2 => [ |
||
60 | 'min' => 1, |
||
61 | 'max' => 31 |
||
62 | ], |
||
63 | 3 => [ |
||
64 | 'min' => 1, |
||
65 | 'max' => 12 |
||
66 | ], |
||
67 | 4 => [ |
||
68 | 'min' => 0, |
||
69 | 'max' => 7 |
||
70 | ] |
||
71 | ]; |
||
72 | |||
73 | /** |
||
74 | * Cron expression |
||
75 | * |
||
76 | * @var string |
||
77 | */ |
||
78 | protected $expression; |
||
79 | |||
80 | /** |
||
81 | * Time zone |
||
82 | * |
||
83 | * @var \DateTimeZone |
||
84 | */ |
||
85 | protected $timeZone; |
||
86 | |||
87 | /** |
||
88 | * Matching register |
||
89 | * |
||
90 | * @var array|null |
||
91 | */ |
||
92 | protected $register; |
||
93 | |||
94 | /** |
||
95 | * Class constructor sets cron expression property |
||
96 | * |
||
97 | * @param string $expression cron expression |
||
98 | * @param \DateTimeZone $timeZone |
||
99 | */ |
||
100 | public function __construct($expression = '* * * * *', \DateTimeZone $timeZone = null) |
||
105 | |||
106 | /** |
||
107 | * Set expression |
||
108 | * |
||
109 | * @param string $expression |
||
110 | * @return self |
||
111 | */ |
||
112 | public function setExpression($expression) |
||
119 | |||
120 | /** |
||
121 | * Set time zone |
||
122 | * |
||
123 | * @param \DateTimeZone $timeZone |
||
124 | * @return self |
||
125 | */ |
||
126 | public function setTimeZone(\DateTimeZone $timeZone = null) |
||
131 | |||
132 | /** |
||
133 | * Calculate next matching timestamp |
||
134 | * |
||
135 | * @param mixed $dtime \DateTime object, timestamp or null |
||
136 | * @return int|bool next matching timestamp, or false on error |
||
137 | */ |
||
138 | public function getNext($dtime = null) |
||
164 | |||
165 | /** |
||
166 | * @param \DateTime $dt |
||
167 | * @param array $pointer |
||
168 | * @return bool |
||
169 | */ |
||
170 | private function forward(\DateTime $dt, array &$pointer) |
||
209 | |||
210 | /** |
||
211 | * Parse and validate cron expression |
||
212 | * |
||
213 | * @return bool true if expression is valid, or false on error |
||
214 | */ |
||
215 | public function isValid() |
||
229 | |||
230 | /** |
||
231 | * Match current or given date/time against cron expression |
||
232 | * |
||
233 | * @param mixed $dtime \DateTime object, timestamp or null |
||
234 | * @return bool |
||
235 | */ |
||
236 | public function isMatching($dtime = null) |
||
255 | |||
256 | /** |
||
257 | * @param array $segments |
||
258 | * @return bool |
||
259 | * @throws \Exception |
||
260 | */ |
||
261 | private function match(array $segments) |
||
274 | |||
275 | /** |
||
276 | * Parse whole cron expression |
||
277 | * |
||
278 | * @return array |
||
279 | * @throws \Exception |
||
280 | */ |
||
281 | private function parse() |
||
299 | |||
300 | /** |
||
301 | * Parse one segment of a cron expression |
||
302 | * |
||
303 | * @param int $index |
||
304 | * @param string $segment |
||
305 | * @param array $register |
||
306 | * @throws \Exception |
||
307 | */ |
||
308 | private function parseSegment($index, array &$register, $segment) |
||
323 | |||
324 | /** |
||
325 | * @param int $index |
||
326 | * @param array $register |
||
327 | * @param string $element |
||
328 | * @throws \Exception |
||
329 | */ |
||
330 | private function parseElement($index, array &$register, $element) |
||
350 | |||
351 | /** |
||
352 | * Parse range of values, e.g. "5-10" |
||
353 | * |
||
354 | * @param int $index |
||
355 | * @param array $register |
||
356 | * @param string $range |
||
357 | * @param int $stepping |
||
358 | * @throws \Exception |
||
359 | */ |
||
360 | private function parseRange($index, array &$register, $range, $stepping) |
||
372 | |||
373 | /** |
||
374 | * Parse stepping notation, e.g. "5-10/2" => 2 |
||
375 | * |
||
376 | * @param int $index |
||
377 | * @param string $element |
||
378 | * @param int $stepping |
||
379 | * @throws \Exception |
||
380 | */ |
||
381 | private function parseStepping($index, &$element, &$stepping) |
||
390 | |||
391 | /** |
||
392 | * Validate whether a given range of values exceeds allowed value boundaries |
||
393 | * |
||
394 | * @param int $index |
||
395 | * @param array $range |
||
396 | * @return array |
||
397 | * @throws \Exception |
||
398 | */ |
||
399 | private function validateRange($index, array $range) |
||
411 | /** |
||
412 | * @param int $index |
||
413 | * @param int $value |
||
414 | * @throws \Exception |
||
415 | */ |
||
416 | private function validateValue($index, $value) |
||
427 | |||
428 | /** |
||
429 | * @param int $index |
||
430 | * @param array $segments |
||
431 | * @throws \Exception |
||
432 | */ |
||
433 | private function validateStepping($index, array $segments) |
||
443 | |||
444 | /** |
||
445 | * @param int $index |
||
446 | * @param array $register |
||
447 | * @param array $range |
||
448 | * @param int $stepping |
||
449 | */ |
||
450 | private function fillRegister($index, array &$register, array $range, $stepping) |
||
462 | |||
463 | /** |
||
464 | * @param int $index |
||
465 | * @param array $register |
||
466 | * @param array $range |
||
467 | * @param int $value |
||
468 | */ |
||
469 | private function fillRegisterAcrossBoundaries($index, array &$register, $range, $value) |
||
475 | |||
476 | /** |
||
477 | * @param int $index |
||
478 | * @param array $register |
||
479 | * @param array $range |
||
480 | * @param int $value |
||
481 | */ |
||
482 | private function fillRegisterBetweenBoundaries($index, array &$register, $range, $value) |
||
488 | } |
||
489 |
You can fix this by adding a namespace to your class:
When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries.