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 |
||
8 | class Cookie |
||
9 | { |
||
10 | /** |
||
11 | * Store for values stored in this PHP runtime |
||
12 | * because when cookie is set with setCookie |
||
13 | * it's accessible on the next script run only, |
||
14 | * not at the same run. |
||
15 | * |
||
16 | * @var array |
||
17 | */ |
||
18 | protected $store = []; |
||
19 | |||
20 | /** |
||
21 | * Get cookie with FILTER_SANITIZE_STRING |
||
22 | * |
||
23 | * @param string $key |
||
24 | * |
||
25 | * @return string|null |
||
26 | */ |
||
27 | 26 | View Code Duplication | public function get($key) |
35 | |||
36 | /** |
||
37 | * Get cookie with FILTER_SANITIZE_NUMBER_INT |
||
38 | * |
||
39 | * @param string $key |
||
40 | * |
||
41 | * @return int|null |
||
42 | */ |
||
43 | 20 | View Code Duplication | public function getInt($key) |
51 | |||
52 | /** |
||
53 | * Set a cookie value |
||
54 | * |
||
55 | * @param string $key |
||
56 | * @param mixed $value |
||
57 | * |
||
58 | * @return bool |
||
59 | */ |
||
60 | 22 | public function set($key, $value) |
|
66 | |||
67 | /** |
||
68 | * Unset the key from the cookie |
||
69 | * |
||
70 | * @param string $key |
||
71 | * |
||
72 | * @return Cookie |
||
73 | */ |
||
74 | 16 | public function clear($key) |
|
82 | |||
83 | /** |
||
84 | * Returns $_COOKIE |
||
85 | * |
||
86 | * @return array |
||
87 | */ |
||
88 | 4 | public function getSuperGlobalCookie() |
|
92 | |||
93 | /** |
||
94 | * Return all cookies as array merged with current state |
||
95 | * |
||
96 | * @return array |
||
97 | */ |
||
98 | 2 | public function toArray() |
|
102 | |||
103 | /** |
||
104 | * Creates unique cookie file in system tmp dir and returns absolute path to it. |
||
105 | * |
||
106 | * @return string|false |
||
107 | */ |
||
108 | 2 | public function createCookieFile() |
|
112 | } |
||
113 |
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.