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 | 90 | public function __construct($expression = '* * * * *', \DateTimeZone $timeZone = null) |
|
105 | |||
106 | /** |
||
107 | * Set expression |
||
108 | * |
||
109 | * @param string $expression |
||
110 | * @return self |
||
111 | */ |
||
112 | 90 | public function setExpression($expression) |
|
119 | |||
120 | /** |
||
121 | * Set time zone |
||
122 | * |
||
123 | * @param \DateTimeZone $timeZone |
||
124 | * @return self |
||
125 | */ |
||
126 | 90 | 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 | 8 | public function getNext($dtime = null) |
|
169 | |||
170 | /** |
||
171 | * @param \DateTime $dtime |
||
172 | * @param array $pointer |
||
173 | * @return array |
||
174 | */ |
||
175 | 8 | private function adjust(\DateTime $dtime, array &$pointer) |
|
210 | |||
211 | /** |
||
212 | * @param \DateTime $dtime |
||
213 | * @param array $current |
||
214 | * @return bool |
||
215 | */ |
||
216 | 8 | private function forward(\DateTime $dtime, array $current) |
|
236 | |||
237 | /** |
||
238 | * Parse and validate cron expression |
||
239 | * |
||
240 | * @return bool true if expression is valid, or false on error |
||
241 | */ |
||
242 | 89 | public function isValid() |
|
256 | |||
257 | /** |
||
258 | * Match current or given date/time against cron expression |
||
259 | * |
||
260 | * @param mixed $dtime \DateTime object, timestamp or null |
||
261 | * @return bool |
||
262 | */ |
||
263 | 90 | public function isMatching($dtime = null) |
|
284 | |||
285 | /** |
||
286 | * @param array $segments |
||
287 | * @return bool |
||
288 | * @throws \Exception |
||
289 | */ |
||
290 | 90 | private function match(array $segments) |
|
303 | |||
304 | /** |
||
305 | * Parse whole cron expression |
||
306 | * |
||
307 | * @return array |
||
308 | * @throws \Exception |
||
309 | */ |
||
310 | 90 | private function parse() |
|
328 | |||
329 | /** |
||
330 | * Parse one segment of a cron expression |
||
331 | * |
||
332 | * @param int $index |
||
333 | * @param string $segment |
||
334 | * @param array $register |
||
335 | * @throws \Exception |
||
336 | */ |
||
337 | 86 | private function parseSegment($index, array &$register, $segment) |
|
352 | |||
353 | /** |
||
354 | * @param int $index |
||
355 | * @param array $register |
||
356 | * @param string $element |
||
357 | * @throws \Exception |
||
358 | */ |
||
359 | 86 | private function parseElement($index, array &$register, $element) |
|
379 | |||
380 | /** |
||
381 | * Parse range of values, e.g. "5-10" |
||
382 | * |
||
383 | * @param int $index |
||
384 | * @param array $register |
||
385 | * @param string $range |
||
386 | * @param int $stepping |
||
387 | * @throws \Exception |
||
388 | */ |
||
389 | 79 | private function parseRange($index, array &$register, $range, $stepping) |
|
401 | |||
402 | /** |
||
403 | * Parse stepping notation, e.g. "5-10/2" => 2 |
||
404 | * |
||
405 | * @param int $index |
||
406 | * @param string $element |
||
407 | * @param int $stepping |
||
408 | * @throws \Exception |
||
409 | */ |
||
410 | 42 | private function parseStepping($index, &$element, &$stepping) |
|
419 | |||
420 | /** |
||
421 | * Validate whether a given range of values exceeds allowed value boundaries |
||
422 | * |
||
423 | * @param int $index |
||
424 | * @param array $range |
||
425 | * @return array |
||
426 | * @throws \Exception |
||
427 | */ |
||
428 | 44 | private function validateRange($index, array $range) |
|
440 | /** |
||
441 | * @param int $index |
||
442 | * @param int $value |
||
443 | * @throws \Exception |
||
444 | */ |
||
445 | 65 | private function validateValue($index, $value) |
|
456 | |||
457 | /** |
||
458 | * @param int $index |
||
459 | * @param array $segments |
||
460 | * @throws \Exception |
||
461 | */ |
||
462 | 42 | private function validateStepping($index, array $segments) |
|
472 | |||
473 | /** |
||
474 | * @param int $index |
||
475 | * @param array $register |
||
476 | * @param array $range |
||
477 | * @param int $stepping |
||
478 | */ |
||
479 | 74 | private function fillRegister($index, array &$register, array $range, $stepping) |
|
491 | |||
492 | /** |
||
493 | * @param int $index |
||
494 | * @param array $register |
||
495 | * @param array $range |
||
496 | * @param int $value |
||
497 | */ |
||
498 | 29 | private function fillRegisterAcrossBoundaries($index, array &$register, $range, $value) |
|
504 | |||
505 | /** |
||
506 | * @param int $index |
||
507 | * @param array $register |
||
508 | * @param array $range |
||
509 | * @param int $value |
||
510 | */ |
||
511 | 73 | private function fillRegisterBetweenBoundaries($index, array &$register, $range, $value) |
|
517 | } |
||
518 |
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.