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 | * Parse and validate cron expression |
||
134 | * |
||
135 | * @return bool true if expression is valid, or false on error |
||
136 | */ |
||
137 | public function isValid() |
||
151 | |||
152 | /** |
||
153 | * Match current or given date/time against cron expression |
||
154 | * |
||
155 | * @param mixed $dtime \DateTime object, timestamp or null |
||
156 | * @return bool |
||
157 | */ |
||
158 | public function isMatching($dtime = null) |
||
177 | |||
178 | /** |
||
179 | * @param array $segments |
||
180 | * @return bool |
||
181 | * @throws \Exception |
||
182 | */ |
||
183 | private function match(array $segments) |
||
196 | |||
197 | /** |
||
198 | * Calculate next matching timestamp |
||
199 | * |
||
200 | * @param mixed $dtime \DateTime object, timestamp or null |
||
201 | * @return int|bool next matching timestamp, or false on error |
||
202 | */ |
||
203 | public function getNext($dtime = null) |
||
264 | |||
265 | /** |
||
266 | * Parse whole cron expression |
||
267 | * |
||
268 | * @return array |
||
269 | * @throws \Exception |
||
270 | */ |
||
271 | private function parse() |
||
289 | |||
290 | /** |
||
291 | * Parse one segment of a cron expression |
||
292 | * |
||
293 | * @param int $index |
||
294 | * @param string $segment |
||
295 | * @param array $register |
||
296 | * @throws \Exception |
||
297 | */ |
||
298 | private function parseSegment($index, array &$register, $segment) |
||
313 | |||
314 | /** |
||
315 | * @param int $index |
||
316 | * @param array $register |
||
317 | * @param string $element |
||
318 | * @throws \Exception |
||
319 | */ |
||
320 | private function parseElement($index, array &$register, $element) |
||
340 | |||
341 | /** |
||
342 | * Parse range of values, e.g. "5-10" |
||
343 | * |
||
344 | * @param int $index |
||
345 | * @param array $register |
||
346 | * @param string $range |
||
347 | * @param int $stepping |
||
348 | * @throws \Exception |
||
349 | */ |
||
350 | private function parseRange($index, array &$register, $range, $stepping) |
||
362 | |||
363 | /** |
||
364 | * Validate whether a given range of values exceeds allowed value boundaries |
||
365 | * |
||
366 | * @param int $index |
||
367 | * @param array $range |
||
368 | * @return array |
||
369 | * @throws \Exception |
||
370 | */ |
||
371 | private function validateRange($index, array $range) |
||
383 | |||
384 | /** |
||
385 | * @param int $index |
||
386 | * @param array $register |
||
387 | * @param array $range |
||
388 | * @param int $stepping |
||
389 | */ |
||
390 | private function fillRegister($index, array &$register, array $range, $stepping) |
||
402 | |||
403 | /** |
||
404 | * @param int $index |
||
405 | * @param array $register |
||
406 | * @param array $range |
||
407 | * @param int $value |
||
408 | */ |
||
409 | private function fillRegisterAcrossBoundaries($index, array &$register, $range, $value) |
||
415 | |||
416 | /** |
||
417 | * @param int $index |
||
418 | * @param array $register |
||
419 | * @param array $range |
||
420 | * @param int $value |
||
421 | */ |
||
422 | private function fillRegisterBetweenBoundaries($index, array &$register, $range, $value) |
||
428 | |||
429 | /** |
||
430 | * @param int $index |
||
431 | * @param int $value |
||
432 | * @throws \Exception |
||
433 | */ |
||
434 | private function validateValue($index, $value) |
||
445 | |||
446 | /** |
||
447 | * Parse stepping notation, e.g. "5-10/2" => 2 |
||
448 | * |
||
449 | * @param int $index |
||
450 | * @param string $element |
||
451 | * @param int $stepping |
||
452 | * @throws \Exception |
||
453 | */ |
||
454 | private function parseStepping($index, &$element, &$stepping) |
||
463 | |||
464 | /** |
||
465 | * @param int $index |
||
466 | * @param array $segments |
||
467 | * @throws \Exception |
||
468 | */ |
||
469 | private function validateStepping($index, array $segments) |
||
479 | } |
||
480 |
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.