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 |
||
9 | final class XmlTypeEncoder implements TypeEncoderInterface |
||
10 | { |
||
11 | /** |
||
12 | * @var bool |
||
13 | */ |
||
14 | private $prettyPrint; |
||
15 | |||
16 | /** |
||
17 | * @param bool $prettyPrint |
||
18 | */ |
||
19 | 4 | public function __construct(bool $prettyPrint = false) |
|
23 | |||
24 | /** |
||
25 | * @return string |
||
26 | */ |
||
27 | 1 | public function getContentType(): string |
|
31 | |||
32 | /** |
||
33 | * @param array $data |
||
34 | * |
||
35 | * @return string |
||
36 | */ |
||
37 | 3 | public function encode(array $data): string |
|
55 | |||
56 | /** |
||
57 | * @param \DOMDocument $document |
||
58 | * @param string $type |
||
59 | * |
||
60 | * @return \DOMNode |
||
61 | */ |
||
62 | 2 | private function createMetadataNode(\DOMDocument $document, string $type): \DOMNode |
|
71 | |||
72 | /** |
||
73 | * @param string $name |
||
74 | * |
||
75 | * @return string |
||
76 | */ |
||
77 | 1 | private function getMetaPrefix(string $name) |
|
81 | |||
82 | /** |
||
83 | * @param \DOMDocument $document |
||
84 | * @param \DOMNode $listNode |
||
85 | * @param array $data |
||
86 | */ |
||
87 | 2 | private function dataToNodes(\DOMDocument $document, \DOMNode $listNode, array $data) |
|
107 | |||
108 | /** |
||
109 | * @param \DOMDocument $document |
||
110 | * @param \DOMNode $listNode |
||
111 | * @param string|int $key |
||
112 | * @param array $value |
||
113 | * |
||
114 | * @return \DOMElement|\DOMNode |
||
115 | */ |
||
116 | 1 | private function dataToArrayNode(\DOMDocument $document, \DOMNode $listNode, $key, array $value) |
|
146 | |||
147 | /** |
||
148 | * @param \DOMDocument $document |
||
149 | * @param \DOMNode $listNode |
||
150 | * @param string|int $key |
||
151 | * @param string|null|bool|float|int $value |
||
152 | * |
||
153 | * @return \DOMNode |
||
154 | */ |
||
155 | 2 | private function dataToScalarNode(\DOMDocument $document, \DOMNode $listNode, $key, $value): \DOMNode |
|
181 | |||
182 | /** |
||
183 | * @param bool|float|int $value |
||
184 | * |
||
185 | * @return string |
||
186 | * |
||
187 | * @throws \InvalidArgumentException |
||
188 | */ |
||
189 | 2 | View Code Duplication | private function getValueAsString($value): string |
210 | |||
211 | /** |
||
212 | * @param bool|float|int|string $value |
||
213 | * |
||
214 | * @return string |
||
215 | */ |
||
216 | 1 | private function getType($value): string |
|
228 | } |
||
229 |
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.