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 |
||
34 | 1 | final class Macros extends MacroSet |
|
35 | { |
||
36 | /** |
||
37 | * Register latte macros |
||
38 | * |
||
39 | * @param Compiler $compiler |
||
40 | * |
||
41 | * @return static |
||
42 | */ |
||
43 | public static function install(Compiler $compiler) |
||
86 | |||
87 | /** |
||
88 | * {isMobile /} |
||
89 | * |
||
90 | * @param MacroNode $node |
||
91 | * @param PhpWriter $writer |
||
92 | * |
||
93 | * @return string |
||
94 | */ |
||
95 | public function macroIsMobile(MacroNode $node, PhpWriter $writer) : string |
||
102 | |||
103 | /** |
||
104 | * {isNotMobile /} |
||
105 | * |
||
106 | * @param MacroNode $node |
||
107 | * @param PhpWriter $writer |
||
108 | * |
||
109 | * @return string |
||
110 | */ |
||
111 | public function macroIsNotMobile(MacroNode $node, PhpWriter $writer) : string |
||
118 | |||
119 | /** |
||
120 | * {isPhone /} |
||
121 | * |
||
122 | * @param MacroNode $node |
||
123 | * @param PhpWriter $writer |
||
124 | * |
||
125 | * @return string |
||
126 | */ |
||
127 | public function macroIsPhone(MacroNode $node, PhpWriter $writer) : string |
||
134 | |||
135 | /** |
||
136 | * {isNotPhone /} |
||
137 | * |
||
138 | * @param MacroNode $node |
||
139 | * @param PhpWriter $writer |
||
140 | * |
||
141 | * @return string |
||
142 | */ |
||
143 | public function macroIsNotPhone(MacroNode $node, PhpWriter $writer) : string |
||
150 | |||
151 | /** |
||
152 | * {isTablet /} |
||
153 | * |
||
154 | * @param MacroNode $node |
||
155 | * @param PhpWriter $writer |
||
156 | * |
||
157 | * @return string |
||
158 | */ |
||
159 | public function macroIsTablet(MacroNode $node, PhpWriter $writer) : string |
||
166 | |||
167 | /** |
||
168 | * {isNotTablet /} |
||
169 | * |
||
170 | * @param MacroNode $node |
||
171 | * @param PhpWriter $writer |
||
172 | * |
||
173 | * @return string |
||
174 | */ |
||
175 | public function macroIsNotTablet(MacroNode $node, PhpWriter $writer) : string |
||
182 | |||
183 | /** |
||
184 | * @param MacroNode $node |
||
185 | * @param PhpWriter $writer |
||
186 | * |
||
187 | * @return string |
||
188 | * |
||
189 | * @throws Exceptions\CompileException |
||
190 | */ |
||
191 | View Code Duplication | public function macroIsDevice(MacroNode $node, PhpWriter $writer) : string |
|
207 | |||
208 | /** |
||
209 | * @param MacroNode $node |
||
210 | * @param PhpWriter $writer |
||
211 | * |
||
212 | * @return string |
||
213 | * |
||
214 | * @throws Exceptions\CompileException |
||
215 | */ |
||
216 | View Code Duplication | public function macroIsOS(MacroNode $node, PhpWriter $writer) : string |
|
232 | |||
233 | /** |
||
234 | * {isFullView /} |
||
235 | * |
||
236 | * @param MacroNode $node |
||
237 | * @param PhpWriter $writer |
||
238 | * |
||
239 | * @return string |
||
240 | */ |
||
241 | public function macroIsFullView(MacroNode $node, PhpWriter $writer) : string |
||
248 | |||
249 | /** |
||
250 | * {isMobileView /} |
||
251 | * |
||
252 | * @param MacroNode $node |
||
253 | * @param PhpWriter $writer |
||
254 | * |
||
255 | * @return string |
||
256 | */ |
||
257 | public function macroIsMobileView(MacroNode $node, PhpWriter $writer) : string |
||
264 | |||
265 | /** |
||
266 | * {isPhoneView /} |
||
267 | * |
||
268 | * @param MacroNode $node |
||
269 | * @param PhpWriter $writer |
||
270 | * |
||
271 | * @return string |
||
272 | */ |
||
273 | public function macroIsPhoneView(MacroNode $node, PhpWriter $writer) : string |
||
280 | |||
281 | /** |
||
282 | * {isTabletView /} |
||
283 | * |
||
284 | * @param MacroNode $node |
||
285 | * @param PhpWriter $writer |
||
286 | * |
||
287 | * @return string |
||
288 | */ |
||
289 | public function macroIsTabletView(MacroNode $node, PhpWriter $writer) : string |
||
296 | |||
297 | /** |
||
298 | * {isNotMobileView /} |
||
299 | * |
||
300 | * @param MacroNode $node |
||
301 | * @param PhpWriter $writer |
||
302 | * |
||
303 | * @return string |
||
304 | */ |
||
305 | public function macroIsNotMobileView(MacroNode $node, PhpWriter $writer) : string |
||
312 | |||
313 | /** |
||
314 | * @param string $macro |
||
315 | * |
||
316 | * @return array |
||
317 | */ |
||
318 | public static function prepareMacroArguments($macro) : array |
||
331 | } |
||
332 |
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.