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 |
||
12 | final class DateTimeTest extends TestCase |
||
13 | { |
||
14 | /** |
||
15 | * Verify basic usage of filter(). |
||
16 | * |
||
17 | * @test |
||
18 | * @covers ::filter |
||
19 | * |
||
20 | * @return void |
||
21 | */ |
||
22 | public function filter() |
||
29 | |||
30 | /** |
||
31 | * Verify behavior of filter() when $value is an integer. |
||
32 | * |
||
33 | * @test |
||
34 | * @covers ::filter |
||
35 | * |
||
36 | * @return void |
||
37 | */ |
||
38 | public function filterTimestamp() |
||
45 | |||
46 | /** |
||
47 | * Verify behavior of filter() when $value is a string with only whitespace. |
||
48 | * |
||
49 | * @param mixed $value The value to be filtered. |
||
|
|||
50 | * |
||
51 | * @test |
||
52 | * @covers ::filter |
||
53 | * @expectedException \TraderInteractive\Filter\Exception |
||
54 | * @expectedExceptionMessage $value is not a non-empty string |
||
55 | * |
||
56 | * @return void |
||
57 | */ |
||
58 | public function filterEmptyValue() |
||
62 | |||
63 | /** |
||
64 | * Verify behavior of filter() when $value is not a string or integer. |
||
65 | * |
||
66 | * @param mixed $value The value to be filtered. |
||
67 | * |
||
68 | * @test |
||
69 | * @covers ::filter |
||
70 | * @expectedException \TraderInteractive\Filter\Exception |
||
71 | * @expectedExceptionMessage $value is not a non-empty string |
||
72 | * |
||
73 | * @return void |
||
74 | */ |
||
75 | public function filterInvalidValue() |
||
79 | |||
80 | /** |
||
81 | * Verify behavior of filter() when $allowNull is not a boolean. |
||
82 | * |
||
83 | * @test |
||
84 | * @expectedException \InvalidArgumentException |
||
85 | * @expectedExceptionMessage $allowNull was not a boolean value |
||
86 | * @covers ::filter |
||
87 | */ |
||
88 | public function filterAllowNullNotBoolean() |
||
92 | |||
93 | /** |
||
94 | * Verify behavior of filter() when null is given for $value and $allowNull is true. |
||
95 | * |
||
96 | * @test |
||
97 | * @covers ::filter |
||
98 | */ |
||
99 | public function filterNullAllowed() |
||
103 | |||
104 | /** |
||
105 | * Verify behavior of filter() when null is given for $value and $allowNull is true. |
||
106 | * |
||
107 | * @test |
||
108 | * @covers ::filter |
||
109 | * @expectedException \TraderInteractive\Filter\Exception |
||
110 | * @expectedExceptionMessage $value is not a non-empty string |
||
111 | */ |
||
112 | public function filterNullNotAllowed() |
||
116 | |||
117 | /** |
||
118 | * Verify behavior of filter() when $value is a \DateTime object. |
||
119 | * |
||
120 | * @test |
||
121 | * @covers ::filter |
||
122 | */ |
||
123 | public function filterDateTimePass() |
||
128 | |||
129 | /** |
||
130 | * Verify behavior of filter() when $timezone is given. |
||
131 | * |
||
132 | * @test |
||
133 | * @covers ::filter |
||
134 | */ |
||
135 | View Code Duplication | public function filterWithTimeZone() |
|
142 | |||
143 | /** |
||
144 | * Verify behavior of filter() when $value is an integer. |
||
145 | * |
||
146 | * @test |
||
147 | * @covers ::filter |
||
148 | */ |
||
149 | public function filterWithIntegerValue() |
||
155 | |||
156 | /** |
||
157 | * Verify behavior of format() when $format is not a string |
||
158 | * |
||
159 | * @test |
||
160 | * @expectedException \InvalidArgumentException |
||
161 | * @expectedExceptionMessage $format is not a non-empty string |
||
162 | * @covers ::format |
||
163 | */ |
||
164 | public function formatNonStringFormat() |
||
168 | |||
169 | /** |
||
170 | * Verify basic behavior of format(). |
||
171 | * |
||
172 | * @test |
||
173 | * @covers ::format |
||
174 | */ |
||
175 | public function format() |
||
180 | } |
||
181 |
This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.
Consider the following example. The parameter
$italy
is not defined by the methodfinale(...)
.The most likely cause is that the parameter was removed, but the annotation was not.