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:
1 | <?php |
||
16 | class DateTimeStrategy implements StrategyInterface |
||
17 | { |
||
18 | /** |
||
19 | * Sets time for the start of a day. |
||
20 | * |
||
21 | * @param \DateTime $datetime The DateTime object. |
||
22 | * |
||
23 | * @return void |
||
24 | * |
||
25 | * @since 2.0.0 |
||
26 | */ |
||
27 | 74 | public function startOfDay(\DateTime $datetime) |
|
31 | |||
32 | /** |
||
33 | * Sets time for the end of a day. |
||
34 | * |
||
35 | * @param \DateTime $datetime The DateTime object. |
||
36 | * |
||
37 | * @return void |
||
38 | * |
||
39 | * @since 2.0.0 |
||
40 | */ |
||
41 | 7 | public function endOfDay(\DateTime $datetime) |
|
45 | |||
46 | /** |
||
47 | * Sets time for the start of a week. |
||
48 | * |
||
49 | * @param \DateTime $datetime The DateTime object. |
||
50 | * |
||
51 | * @return void |
||
52 | * |
||
53 | * @since 2.0.0 |
||
54 | */ |
||
55 | 2 | View Code Duplication | public function startOfWeek(\DateTime $datetime) |
62 | |||
63 | /** |
||
64 | * Sets time for the end of a week. |
||
65 | * |
||
66 | * @param \DateTime $datetime The DateTime object. |
||
67 | * |
||
68 | * @return void |
||
69 | * |
||
70 | * @since 2.0.0 |
||
71 | */ |
||
72 | 2 | View Code Duplication | public function endOfWeek(\DateTime $datetime) |
79 | |||
80 | /** |
||
81 | * Sets time for the start of a month. |
||
82 | * |
||
83 | * @param \DateTime $datetime The DateTime object. |
||
84 | * |
||
85 | * @return void |
||
86 | * |
||
87 | * @since 2.0.0 |
||
88 | */ |
||
89 | 2 | public function startOfMonth(\DateTime $datetime) |
|
96 | |||
97 | /** |
||
98 | * Sets time for the end of a month. |
||
99 | * |
||
100 | * @param \DateTime $datetime The DateTime object. |
||
101 | * |
||
102 | * @return void |
||
103 | * |
||
104 | * @since 2.0.0 |
||
105 | */ |
||
106 | 2 | public function endOfMonth(\DateTime $datetime) |
|
114 | |||
115 | /** |
||
116 | * Sets time for the start of a year. |
||
117 | * |
||
118 | * @param \DateTime $datetime The DateTime object. |
||
119 | * |
||
120 | * @return void |
||
121 | * |
||
122 | * @since 2.0.0 |
||
123 | */ |
||
124 | 2 | public function startOfYear(\DateTime $datetime) |
|
129 | |||
130 | /** |
||
131 | * Sets time for the end of a year. |
||
132 | * |
||
133 | * @param \DateTime $datetime The DateTime object. |
||
134 | * |
||
135 | * @return void |
||
136 | * |
||
137 | * @since 2.0.0 |
||
138 | */ |
||
139 | 2 | public function endOfYear(\DateTime $datetime) |
|
144 | } |
||
145 |
Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.
You can also find more detailed suggestions in the “Code” section of your repository.