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 | */ |
||
17 | View Code Duplication | class PHPCompatibility_Sniffs_PHP_NewFunctionsSniff extends PHPCompatibility_Sniff |
|
18 | { |
||
19 | |||
20 | /** |
||
21 | * If true, forbidden functions will be considered regular expressions. |
||
22 | * |
||
23 | * @var bool |
||
24 | */ |
||
25 | protected $patternMatch = false; |
||
26 | |||
27 | /** |
||
28 | * A list of new functions, not present in older versions. |
||
29 | * |
||
30 | * The array lists : version number with false (not present) or true (present). |
||
31 | * If's sufficient to list the first version where the function appears. |
||
32 | * |
||
33 | * @var array(string => array(string => int|string|null)) |
||
34 | */ |
||
35 | protected $forbiddenFunctions = array( |
||
36 | 'array_fill_keys' => array( |
||
37 | '5.1' => false, |
||
38 | '5.2' => true |
||
39 | ), |
||
40 | 'error_get_last' => array( |
||
41 | '5.1' => false, |
||
42 | '5.2' => true |
||
43 | ), |
||
44 | 'image_type_to_extension' => array( |
||
45 | '5.1' => false, |
||
46 | '5.2' => true |
||
47 | ), |
||
48 | 'memory_get_peak_usage' => array( |
||
49 | '5.1' => false, |
||
50 | '5.2' => true |
||
51 | ), |
||
52 | 'sys_get_temp_dir' => array( |
||
53 | '5.1' => false, |
||
54 | '5.2' => true |
||
55 | ), |
||
56 | 'timezone_abbreviations_list' => array( |
||
57 | '5.1' => false, |
||
58 | '5.2' => true |
||
59 | ), |
||
60 | 'timezone_identifiers_list' => array( |
||
61 | '5.1' => false, |
||
62 | '5.2' => true |
||
63 | ), |
||
64 | 'timezone_name_from_abbr' => array( |
||
65 | '5.1' => false, |
||
66 | '5.2' => true |
||
67 | ), |
||
68 | 'stream_socket_shutdown' => array( |
||
69 | '5.1' => false, |
||
70 | '5.2' => true |
||
71 | ), |
||
72 | 'imagegrabscreen' => array( |
||
73 | '5.1' => false, |
||
74 | '5.2' => true |
||
75 | ), |
||
76 | 'imagegrabwindow' => array( |
||
77 | '5.1' => false, |
||
78 | '5.2' => true |
||
79 | ), |
||
80 | 'libxml_disable_entity_loader' => array( |
||
81 | '5.1' => false, |
||
82 | '5.2' => true |
||
83 | ), |
||
84 | 'mb_stripos' => array( |
||
85 | '5.1' => false, |
||
86 | '5.2' => true |
||
87 | ), |
||
88 | 'mb_stristr' => array( |
||
89 | '5.1' => false, |
||
90 | '5.2' => true |
||
91 | ), |
||
92 | 'mb_strrchr' => array( |
||
93 | '5.1' => false, |
||
94 | '5.2' => true |
||
95 | ), |
||
96 | 'mb_strrichr' => array( |
||
97 | '5.1' => false, |
||
98 | '5.2' => true |
||
99 | ), |
||
100 | 'mb_strripos' => array( |
||
101 | '5.1' => false, |
||
102 | '5.2' => true |
||
103 | ), |
||
104 | 'ming_setSWFCompression' => array( |
||
105 | '5.1' => false, |
||
106 | '5.2' => true |
||
107 | ), |
||
108 | 'openssl_csr_get_public_key' => array( |
||
109 | '5.1' => false, |
||
110 | '5.2' => true |
||
111 | ), |
||
112 | 'openssl_csr_get_subject' => array( |
||
113 | '5.1' => false, |
||
114 | '5.2' => true |
||
115 | ), |
||
116 | 'openssl_pkey_get_details' => array( |
||
117 | '5.1' => false, |
||
118 | '5.2' => true |
||
119 | ), |
||
120 | 'spl_object_hash' => array( |
||
121 | '5.1' => false, |
||
122 | '5.2' => true |
||
123 | ), |
||
124 | 'iterator_apply' => array( |
||
125 | '5.1' => false, |
||
126 | '5.2' => true |
||
127 | ), |
||
128 | 'preg_last_error' => array( |
||
129 | '5.1' => false, |
||
130 | '5.2' => true |
||
131 | ), |
||
132 | 'pg_field_table' => array( |
||
133 | '5.1' => false, |
||
134 | '5.2' => true |
||
135 | ), |
||
136 | 'posix_initgroups' => array( |
||
137 | '5.1' => false, |
||
138 | '5.2' => true |
||
139 | ), |
||
140 | 'gmp_nextprime' => array( |
||
141 | '5.1' => false, |
||
142 | '5.2' => true |
||
143 | ), |
||
144 | 'xmlwriter_full_end_element' => array( |
||
145 | '5.1' => false, |
||
146 | '5.2' => true |
||
147 | ), |
||
148 | 'xmlwriter_write_raw' => array( |
||
149 | '5.1' => false, |
||
150 | '5.2' => true |
||
151 | ), |
||
152 | 'xmlwriter_start_dtd_entity' => array( |
||
153 | '5.1' => false, |
||
154 | '5.2' => true |
||
155 | ), |
||
156 | 'xmlwriter_end_dtd_entity' => array( |
||
157 | '5.1' => false, |
||
158 | '5.2' => true |
||
159 | ), |
||
160 | 'xmlwriter_write_dtd_entity' => array( |
||
161 | '5.1' => false, |
||
162 | '5.2' => true |
||
163 | ), |
||
164 | 'filter_has_var' => array( |
||
165 | '5.1' => false, |
||
166 | '5.2' => true |
||
167 | ), |
||
168 | 'filter_id' => array( |
||
169 | '5.1' => false, |
||
170 | '5.2' => true |
||
171 | ), |
||
172 | 'filter_input_array' => array( |
||
173 | '5.1' => false, |
||
174 | '5.2' => true |
||
175 | ), |
||
176 | 'filter_input' => array( |
||
177 | '5.1' => false, |
||
178 | '5.2' => true |
||
179 | ), |
||
180 | 'filter_list' => array( |
||
181 | '5.1' => false, |
||
182 | '5.2' => true |
||
183 | ), |
||
184 | 'filter_var_array' => array( |
||
185 | '5.1' => false, |
||
186 | '5.2' => true |
||
187 | ), |
||
188 | 'filter_var' => array( |
||
189 | '5.1' => false, |
||
190 | '5.2' => true |
||
191 | ), |
||
192 | 'json_decode' => array( |
||
193 | '5.1' => false, |
||
194 | '5.2' => true |
||
195 | ), |
||
196 | 'json_encode' => array( |
||
197 | '5.1' => false, |
||
198 | '5.2' => true |
||
199 | ), |
||
200 | 'zip_close' => array( |
||
201 | '5.1' => false, |
||
202 | '5.2' => true |
||
203 | ), |
||
204 | 'zip_entry_close' => array( |
||
205 | '5.1' => false, |
||
206 | '5.2' => true |
||
207 | ), |
||
208 | 'zip_entry_compressedsize' => array( |
||
209 | '5.1' => false, |
||
210 | '5.2' => true |
||
211 | ), |
||
212 | 'zip_entry_compressionmethod' => array( |
||
213 | '5.1' => false, |
||
214 | '5.2' => true |
||
215 | ), |
||
216 | 'zip_entry_filesize' => array( |
||
217 | '5.1' => false, |
||
218 | '5.2' => true |
||
219 | ), |
||
220 | 'zip_entry_name' => array( |
||
221 | '5.1' => false, |
||
222 | '5.2' => true |
||
223 | ), |
||
224 | 'zip_entry_open' => array( |
||
225 | '5.1' => false, |
||
226 | '5.2' => true |
||
227 | ), |
||
228 | 'zip_entry_read' => array( |
||
229 | '5.1' => false, |
||
230 | '5.2' => true |
||
231 | ), |
||
232 | 'zip_open' => array( |
||
233 | '5.1' => false, |
||
234 | '5.2' => true |
||
235 | ), |
||
236 | 'zip_read' => array( |
||
237 | '5.1' => false, |
||
238 | '5.2' => true |
||
239 | ), |
||
240 | |||
241 | 'array_replace' => array( |
||
242 | '5.2' => false, |
||
243 | '5.3' => true |
||
244 | ), |
||
245 | 'array_replace_recursive' => array( |
||
246 | '5.2' => false, |
||
247 | '5.3' => true |
||
248 | ), |
||
249 | 'class_alias' => array( |
||
250 | '5.2' => false, |
||
251 | '5.3' => true |
||
252 | ), |
||
253 | 'forward_static_call' => array( |
||
254 | '5.2' => false, |
||
255 | '5.3' => true |
||
256 | ), |
||
257 | 'forward_static_call_array' => array( |
||
258 | '5.2' => false, |
||
259 | '5.3' => true |
||
260 | ), |
||
261 | 'gc_collect_cycles' => array( |
||
262 | '5.2' => false, |
||
263 | '5.3' => true |
||
264 | ), |
||
265 | 'gc_disable' => array( |
||
266 | '5.2' => false, |
||
267 | '5.3' => true |
||
268 | ), |
||
269 | 'gc_enable' => array( |
||
270 | '5.2' => false, |
||
271 | '5.3' => true |
||
272 | ), |
||
273 | 'gc_enabled' => array( |
||
274 | '5.2' => false, |
||
275 | '5.3' => true |
||
276 | ), |
||
277 | 'get_called_class' => array( |
||
278 | '5.2' => false, |
||
279 | '5.3' => true |
||
280 | ), |
||
281 | 'gethostname' => array( |
||
282 | '5.2' => false, |
||
283 | '5.3' => true |
||
284 | ), |
||
285 | 'header_remove' => array( |
||
286 | '5.2' => false, |
||
287 | '5.3' => true |
||
288 | ), |
||
289 | 'lcfirst' => array( |
||
290 | '5.2' => false, |
||
291 | '5.3' => true |
||
292 | ), |
||
293 | 'parse_ini_string' => array( |
||
294 | '5.2' => false, |
||
295 | '5.3' => true |
||
296 | ), |
||
297 | 'quoted_printable_encode' => array( |
||
298 | '5.2' => false, |
||
299 | '5.3' => true |
||
300 | ), |
||
301 | 'str_getcsv' => array( |
||
302 | '5.2' => false, |
||
303 | '5.3' => true |
||
304 | ), |
||
305 | 'stream_context_set_default' => array( |
||
306 | '5.2' => false, |
||
307 | '5.3' => true |
||
308 | ), |
||
309 | 'stream_supports_lock' => array( |
||
310 | '5.2' => false, |
||
311 | '5.3' => true |
||
312 | ), |
||
313 | 'stream_context_get_params' => array( |
||
314 | '5.2' => false, |
||
315 | '5.3' => true |
||
316 | ), |
||
317 | 'date_add' => array( |
||
318 | '5.2' => false, |
||
319 | '5.3' => true |
||
320 | ), |
||
321 | 'date_create_from_format' => array( |
||
322 | '5.2' => false, |
||
323 | '5.3' => true |
||
324 | ), |
||
325 | 'date_diff' => array( |
||
326 | '5.2' => false, |
||
327 | '5.3' => true |
||
328 | ), |
||
329 | 'date_get_last_errors' => array( |
||
330 | '5.2' => false, |
||
331 | '5.3' => true |
||
332 | ), |
||
333 | 'date_parse_from_format' => array( |
||
334 | '5.2' => false, |
||
335 | '5.3' => true |
||
336 | ), |
||
337 | 'date_sub' => array( |
||
338 | '5.2' => false, |
||
339 | '5.3' => true |
||
340 | ), |
||
341 | 'timezone_version_get' => array( |
||
342 | '5.2' => false, |
||
343 | '5.3' => true |
||
344 | ), |
||
345 | 'gmp_testbit' => array( |
||
346 | '5.2' => false, |
||
347 | '5.3' => true |
||
348 | ), |
||
349 | 'hash_copy' => array( |
||
350 | '5.2' => false, |
||
351 | '5.3' => true |
||
352 | ), |
||
353 | 'imap_gc' => array( |
||
354 | '5.2' => false, |
||
355 | '5.3' => true |
||
356 | ), |
||
357 | 'imap_utf8_to_mutf7' => array( |
||
358 | '5.2' => false, |
||
359 | '5.3' => true |
||
360 | ), |
||
361 | 'imap_mutf7_to_utf8' => array( |
||
362 | '5.2' => false, |
||
363 | '5.3' => true |
||
364 | ), |
||
365 | 'json_last_error' => array( |
||
366 | '5.2' => false, |
||
367 | '5.3' => true |
||
368 | ), |
||
369 | 'mysqli_get_cache_stats' => array( |
||
370 | '5.2' => false, |
||
371 | '5.3' => true |
||
372 | ), |
||
373 | 'mysqli_fetch_all' => array( |
||
374 | '5.2' => false, |
||
375 | '5.3' => true |
||
376 | ), |
||
377 | 'mysqli_get_connection_status' => array( |
||
378 | '5.2' => false, |
||
379 | '5.3' => true |
||
380 | ), |
||
381 | 'mysqli_poll' => array( |
||
382 | '5.2' => false, |
||
383 | '5.3' => true |
||
384 | ), |
||
385 | 'mysqli_read_async_query' => array( |
||
386 | '5.2' => false, |
||
387 | '5.3' => true |
||
388 | ), |
||
389 | 'openssl_random_pseudo_bytes' => array( |
||
390 | '5.2' => false, |
||
391 | '5.3' => true |
||
392 | ), |
||
393 | 'pcntl_signal_dispatch' => array( |
||
394 | '5.2' => false, |
||
395 | '5.3' => true |
||
396 | ), |
||
397 | 'pcntl_sigprocmask' => array( |
||
398 | '5.2' => false, |
||
399 | '5.3' => true |
||
400 | ), |
||
401 | 'pcntl_sigtimedwait' => array( |
||
402 | '5.2' => false, |
||
403 | '5.3' => true |
||
404 | ), |
||
405 | 'pcntl_sigwaitinfo' => array( |
||
406 | '5.2' => false, |
||
407 | '5.3' => true |
||
408 | ), |
||
409 | 'preg_filter' => array( |
||
410 | '5.2' => false, |
||
411 | '5.3' => true |
||
412 | ), |
||
413 | 'msg_queue_exists' => array( |
||
414 | '5.2' => false, |
||
415 | '5.3' => true |
||
416 | ), |
||
417 | 'shm_has_vars' => array( |
||
418 | '5.2' => false, |
||
419 | '5.3' => true |
||
1350 |
This check looks for classes that have been defined more than once.
If you can, we would recommend to use standard object-oriented programming techniques. For example, to avoid multiple types, it might make sense to create a common interface, and then multiple, different implementations for that interface.
This also has the side-effect of providing you with better IDE auto-completion, static analysis and also better OPCode caching from PHP.