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 |
||
12 | class RandomOrgAPI implements RandomOrgAPIInterface |
||
13 | { |
||
14 | /** |
||
15 | * The default Random.org endpoint template. |
||
16 | * |
||
17 | * @var string; |
||
18 | */ |
||
19 | private $endpoint = 'https://api.random.org/json-rpc/1/invoke'; |
||
20 | |||
21 | /** |
||
22 | * The configuration. |
||
23 | * |
||
24 | * @var array |
||
25 | */ |
||
26 | private $configuration; |
||
27 | |||
28 | /** |
||
29 | * The HTTP client. |
||
30 | * |
||
31 | * @var \Http\Client\HttpClient |
||
32 | */ |
||
33 | private $httpClient; |
||
34 | |||
35 | /** |
||
36 | * RandomOrgAPI constructor. |
||
37 | * |
||
38 | * @param array $configuration |
||
39 | */ |
||
40 | 5 | public function __construct(array $configuration = []) |
|
41 | { |
||
42 | 5 | $this->configuration = $configuration; |
|
43 | 5 | } |
|
44 | |||
45 | /** |
||
46 | * {@inheritdoc} |
||
47 | */ |
||
48 | 2 | public function withApiKey(string $apikey) |
|
49 | { |
||
50 | 2 | $clone = clone $this; |
|
51 | |||
52 | 2 | return $clone->setApiKey($apikey); |
|
53 | } |
||
54 | |||
55 | /** |
||
56 | * {@inheritdoc} |
||
57 | */ |
||
58 | 1 | public function withEndPoint(string $endpoint) |
|
59 | { |
||
60 | 1 | $clone = clone $this; |
|
61 | |||
62 | 1 | return $clone->setEndPoint($endpoint); |
|
63 | } |
||
64 | |||
65 | /** |
||
66 | * {@inheritdoc} |
||
67 | */ |
||
68 | 1 | public function withHttpClient(HttpClient $client) |
|
69 | { |
||
70 | 1 | $clone = clone $this; |
|
71 | |||
72 | 1 | return $clone->setHttpClient($client); |
|
73 | } |
||
74 | |||
75 | /** |
||
76 | * {@inheritdoc} |
||
77 | */ |
||
78 | 1 | public function getEndPoint() |
|
79 | { |
||
80 | 1 | return $this->endpoint; |
|
81 | } |
||
82 | |||
83 | /** |
||
84 | * {@inheritdoc} |
||
85 | */ |
||
86 | 1 | public function getApiKey() |
|
87 | { |
||
88 | 1 | $configuration = $this->getConfiguration(); |
|
89 | |||
90 | 1 | $configuration += ['apiKey' => '']; |
|
91 | |||
92 | 1 | return $configuration['apiKey']; |
|
93 | } |
||
94 | |||
95 | /** |
||
96 | * {@inheritdoc} |
||
97 | */ |
||
98 | public function call(MethodPluginInterface $methodPlugin) |
||
99 | { |
||
100 | return $this->validateResponse($methodPlugin |
||
101 | ->withEndPoint($this->getEndPoint()) |
||
102 | ->withApiKey($this->getApiKey())->call()); |
||
103 | } |
||
104 | |||
105 | /** |
||
106 | * {@inheritdoc} |
||
107 | */ |
||
108 | public function get(MethodPluginInterface $methodPlugin) |
||
109 | { |
||
110 | return json_decode( |
||
111 | (string) $this |
||
|
|||
112 | ->call($methodPlugin) |
||
113 | ->getBody() |
||
114 | ->getContents(), |
||
115 | true |
||
116 | ); |
||
117 | } |
||
118 | |||
119 | /** |
||
120 | * {@inheritdoc} |
||
121 | */ |
||
122 | public function getData(MethodPluginInterface $methodPlugin) |
||
123 | { |
||
124 | $data = $this->get($methodPlugin); |
||
125 | |||
126 | if (!isset($data['result'])) { |
||
127 | return false; |
||
128 | } |
||
129 | |||
130 | if (isset($data['result']['random']) && isset($data['result']['random']['data'])) { |
||
131 | return $data['result']['random']['data']; |
||
132 | } |
||
133 | |||
134 | return false; |
||
135 | } |
||
136 | |||
137 | /** |
||
138 | * {@inheritdoc} |
||
139 | */ |
||
140 | 2 | public function getConfiguration() |
|
141 | { |
||
142 | 2 | return $this->configuration; |
|
143 | } |
||
144 | |||
145 | /** |
||
146 | * {@inheritdoc} |
||
147 | */ |
||
148 | 1 | public function getHttpClient() |
|
149 | { |
||
150 | 1 | return $this->httpClient; |
|
151 | } |
||
152 | |||
153 | /** |
||
154 | * @param string $apikey |
||
155 | * |
||
156 | * @return $this |
||
157 | */ |
||
158 | 2 | private function setApiKey(string $apikey) |
|
159 | { |
||
160 | 2 | $configuration = $this->getConfiguration(); |
|
161 | 2 | $configuration['apiKey'] = $apikey; |
|
162 | |||
163 | 2 | return $this->setConfiguration($configuration); |
|
164 | } |
||
165 | |||
166 | /** |
||
167 | * @param string $endpoint |
||
168 | * |
||
169 | * @return $this |
||
170 | */ |
||
171 | 1 | private function setEndPoint(string $endpoint) |
|
177 | |||
178 | /** |
||
179 | * Validate the response. |
||
180 | * |
||
181 | * @param \Psr\Http\Message\ResponseInterface $response |
||
182 | * |
||
183 | * @return \Exception|ResponseInterface |
||
184 | */ |
||
185 | private function validateResponse(ResponseInterface $response) |
||
186 | { |
||
187 | if (200 == $response->getStatusCode()) { |
||
188 | $body = json_decode((string) $response->getBody()->getContents(), true); |
||
189 | |||
190 | if (isset($body['error']['code'])) { |
||
191 | switch ($body['error']['code']) { |
||
192 | View Code Duplication | case -32600: |
|
193 | throw new \InvalidArgumentException( |
||
194 | 'Invalid Request: ' . $body['error']['message'], |
||
195 | $body['error']['code'] |
||
196 | ); |
||
197 | case -32601: |
||
198 | throw new \BadFunctionCallException( |
||
199 | 'Procedure not found: ' . $body['error']['message'], |
||
200 | $body['error']['code'] |
||
201 | ); |
||
202 | View Code Duplication | case -32602: |
|
203 | throw new \InvalidArgumentException( |
||
204 | 'Invalid arguments: ' . $body['error']['message'], |
||
205 | $body['error']['code'] |
||
206 | ); |
||
207 | View Code Duplication | case -32603: |
|
208 | throw new \RuntimeException( |
||
209 | 'Internal Error: ' . $body['error']['message'], |
||
210 | $body['error']['code'] |
||
211 | ); |
||
212 | View Code Duplication | default: |
|
213 | throw new \RuntimeException( |
||
214 | 'Invalid request/response: ' . $body['error']['message'], |
||
215 | $body['error']['code'] |
||
216 | ); |
||
217 | } |
||
218 | } |
||
219 | } |
||
220 | |||
221 | $response->getBody()->rewind(); |
||
222 | |||
223 | return $response; |
||
224 | } |
||
225 | |||
226 | /** |
||
227 | * @param $configuration |
||
228 | * |
||
229 | * @return $this |
||
230 | */ |
||
231 | 2 | private function setConfiguration($configuration) |
|
237 | |||
238 | /** |
||
239 | * Set the HTTP client. |
||
240 | * |
||
241 | * @param \Http\Client\HttpClient $client |
||
242 | * |
||
243 | * @return \drupol\Yaroc\RandomOrgAPI |
||
244 | */ |
||
245 | 1 | private function setHttpClient(HttpClient $client) |
|
251 | } |
||
252 |
It seems like the method you are trying to call exists only in some of the possible types.
Let’s take a look at an example:
Available Fixes
Add an additional type-check:
Only allow a single type to be passed if the variable comes from a parameter: