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 declare(strict_types=1); |
||
8 | class Config |
||
9 | { |
||
10 | /** |
||
11 | * @var string |
||
12 | */ |
||
13 | private $header; |
||
14 | |||
15 | /** |
||
16 | * @var string |
||
17 | */ |
||
18 | private $defaultEnvironment; |
||
19 | |||
20 | /** |
||
21 | * @var ConfigEnvironment[] |
||
22 | */ |
||
23 | private $environments; |
||
24 | |||
25 | /** |
||
26 | * @var array |
||
27 | */ |
||
28 | private $params; |
||
29 | |||
30 | /** |
||
31 | * @param string|null $header |
||
32 | * @param string $defaultEnvironment |
||
33 | * @param ConfigEnvironment[] $environments |
||
34 | * @param array $params |
||
35 | */ |
||
36 | public function __construct( |
||
47 | |||
48 | /** |
||
49 | * @return ScriptPath[] |
||
50 | */ |
||
51 | public function getAllScriptPaths(): array |
||
52 | { |
||
53 | $paths = []; |
||
54 | |||
55 | View Code Duplication | foreach ($this->environments as $name => $environmentConfig) { |
|
|
|||
56 | foreach ($environmentConfig->getAllScriptPaths() as $path) { |
||
57 | if ($name !== $this->defaultEnvironment) { |
||
58 | $paths[] = new ScriptPath($path, $name); |
||
59 | } else { |
||
60 | $paths[] = new ScriptPath($path); |
||
61 | } |
||
62 | } |
||
63 | } |
||
64 | |||
65 | return $paths; |
||
66 | } |
||
67 | |||
68 | /** |
||
69 | * @param string|null $environment |
||
70 | * @return array |
||
71 | */ |
||
72 | public function getTemplates(string $environment = null): array |
||
79 | |||
80 | /** |
||
81 | * @param string|null $environment |
||
82 | * @return array |
||
83 | */ |
||
84 | public function getDynamicVariables(string $environment = null): array |
||
91 | |||
92 | /** |
||
93 | * @param string|null $environment |
||
94 | * @return array |
||
95 | */ |
||
96 | public function getConstants(string $environment = null): array |
||
104 | |||
105 | /** |
||
106 | * @param string|null $environmentString |
||
107 | * |
||
108 | * @return ScriptPath[] |
||
109 | */ |
||
110 | public function getDotenvPaths(string $environmentString = null): array |
||
128 | |||
129 | /** |
||
130 | * @return string |
||
131 | */ |
||
132 | public function getHeader() |
||
136 | |||
137 | /** |
||
138 | * @return ConfigEnvironment[] |
||
139 | */ |
||
140 | public function getEnvironments(): array |
||
144 | |||
145 | /** |
||
146 | * @return string |
||
147 | */ |
||
148 | public function getDefaultEnvironment(): string |
||
152 | |||
153 | /** |
||
154 | * @return array |
||
155 | */ |
||
156 | public function getParams() : array |
||
160 | |||
161 | /** |
||
162 | * @param callable[] ...$valueProviders |
||
163 | * @return array |
||
164 | */ |
||
165 | private function createResult(callable ...$valueProviders): array |
||
177 | |||
178 | /** |
||
179 | * @param string|null $name |
||
180 | * @return ConfigEnvironment |
||
181 | */ |
||
182 | private function getEnvironment(string $name = null): ConfigEnvironment |
||
190 | |||
191 | /** |
||
192 | * @param ConfigEnvironment $environmentConfig |
||
193 | * @param string|null $name |
||
194 | * |
||
195 | * @return array |
||
196 | */ |
||
197 | private function resolveEnvironmentDotEnvPaths(ConfigEnvironment $environmentConfig, string $name = null): array |
||
211 | } |
||
212 |
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.