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 |
||
10 | final class JsonxTypeEncoder implements TypeEncoderInterface |
||
11 | { |
||
12 | /** |
||
13 | * @var bool |
||
14 | */ |
||
15 | private $prettyPrint; |
||
16 | |||
17 | const DATATYPE_OBJECT = 'object'; |
||
18 | const DATATYPE_ARRAY = 'array'; |
||
19 | const DATATYPE_BOOLEAN = 'boolean'; |
||
20 | const DATATYPE_STRING = 'string'; |
||
21 | const DATATYPE_NUMBER = 'number'; |
||
22 | const DATATYPE_NULL = 'null'; |
||
23 | |||
24 | /** |
||
25 | * @param bool $prettyPrint |
||
26 | */ |
||
27 | 4 | public function __construct(bool $prettyPrint = false) |
|
31 | |||
32 | /** |
||
33 | * @return string |
||
34 | */ |
||
35 | 1 | public function getContentType(): string |
|
39 | |||
40 | /** |
||
41 | * @param array $data |
||
42 | * |
||
43 | * @return string |
||
44 | */ |
||
45 | 3 | public function encode(array $data): string |
|
46 | { |
||
47 | 3 | $document = new \DOMDocument('1.0', 'UTF-8'); |
|
48 | 3 | $document->formatOutput = $this->prettyPrint; |
|
49 | |||
50 | 3 | if (self::DATATYPE_OBJECT === $this->getType($data)) { |
|
51 | 2 | $rootNode = $this->createObjectNode($document, $data); |
|
52 | } else { |
||
53 | 1 | $rootNode = $this->createArrayNode($document, $data); |
|
54 | } |
||
55 | |||
56 | 2 | $rootNode->setAttribute('xsi:schemaLocation', 'http://www.datapower.com/schemas/json jsonx.xsd'); |
|
57 | 2 | $rootNode->setAttribute('xmlns:xsi', 'http://www.w3.org/2001/XMLSchema-instance'); |
|
58 | 2 | $rootNode->setAttribute('xmlns:json', 'http://www.ibm.com/xmlns/prod/2009/jsonx'); |
|
59 | |||
60 | 2 | $document->appendChild($rootNode); |
|
61 | |||
62 | 2 | return trim($document->saveXML($document)); |
|
63 | } |
||
64 | |||
65 | /** |
||
66 | * @param \DOMDocument $document |
||
67 | * @param string $name |
||
68 | * @param array $value |
||
69 | * |
||
70 | * @return \DOMNode |
||
71 | */ |
||
72 | 3 | private function createObjectNode(\DOMDocument $document, array $value, string $name = null): \DOMNode |
|
101 | |||
102 | /** |
||
103 | * @param \DOMDocument $document |
||
104 | * @param array $value |
||
105 | * @param string $name |
||
106 | * |
||
107 | * @return \DOMNode |
||
108 | */ |
||
109 | 2 | private function createArrayNode(\DOMDocument $document, array $value, string $name = null): \DOMNode |
|
110 | { |
||
111 | 2 | $node = $document->createElement('json:array'); |
|
112 | |||
113 | 2 | if (null !== $name) { |
|
114 | 1 | $node->setAttribute('name', $name); |
|
115 | } |
||
116 | |||
117 | 2 | foreach ($value as $subValue) { |
|
118 | 2 | $subValueType = $this->getType($subValue); |
|
119 | 2 | if (self::DATATYPE_OBJECT === $subValueType) { |
|
120 | 2 | $subNode = $this->createObjectNode($document, $subValue); |
|
121 | 1 | } elseif (self::DATATYPE_ARRAY === $subValueType) { |
|
122 | 1 | $subNode = $this->createArrayNode($document, $subValue); |
|
123 | 1 | } elseif (self::DATATYPE_BOOLEAN === $subValueType) { |
|
124 | 1 | $subNode = $this->createBooleanNode($document, $subValue); |
|
125 | 1 | } elseif (self::DATATYPE_STRING === $subValueType) { |
|
126 | 1 | $subNode = $this->createStringNode($document, $subValue); |
|
127 | 1 | } elseif (self::DATATYPE_NUMBER === $subValueType) { |
|
128 | 1 | $subNode = $this->createNumberNode($document, $subValue); |
|
129 | } else { |
||
130 | 1 | $subNode = $this->createNullNode($document); |
|
131 | } |
||
132 | |||
133 | 2 | $node->appendChild($subNode); |
|
134 | } |
||
135 | |||
136 | 2 | return $node; |
|
137 | } |
||
138 | |||
139 | /** |
||
140 | * @param \DOMDocument $document |
||
141 | * @param bool $value |
||
142 | * @param string $name |
||
143 | * |
||
144 | * @return \DOMNode |
||
145 | */ |
||
146 | 2 | View Code Duplication | private function createBooleanNode(\DOMDocument $document, bool $value, string $name = null): \DOMNode |
156 | |||
157 | /** |
||
158 | * @param \DOMDocument $document |
||
159 | * @param string $value |
||
160 | * @param string $name |
||
161 | * |
||
162 | * @return \DOMNode |
||
163 | */ |
||
164 | 2 | private function createStringNode(\DOMDocument $document, string $value, string $name = null): \DOMNode |
|
174 | |||
175 | /** |
||
176 | * @param \DOMDocument $document |
||
177 | * @param int|float $value |
||
178 | * @param string $name |
||
179 | * |
||
180 | * @return \DOMNode |
||
181 | */ |
||
182 | 2 | View Code Duplication | private function createNumberNode(\DOMDocument $document, $value, string $name = null): \DOMNode |
192 | |||
193 | /** |
||
194 | * @param \DOMDocument $document |
||
195 | * @param string $name |
||
196 | * |
||
197 | * @return \DOMNode |
||
198 | */ |
||
199 | 2 | private function createNullNode(\DOMDocument $document, string $name = null): \DOMNode |
|
209 | |||
210 | /** |
||
211 | * @param array|bool|string|int|float|null $value |
||
212 | * |
||
213 | * @return string |
||
214 | */ |
||
215 | 3 | private function getType($value): string |
|
248 | } |
||
249 |
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.