Complex classes like MediawikiApi often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use MediawikiApi, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
25 | class MediawikiApi implements MediawikiApiInterface, LoggerAwareInterface { |
||
26 | |||
27 | /** |
||
28 | * @var ClientInterface|null Should be accessed through getClient |
||
29 | */ |
||
30 | private $client = null; |
||
31 | |||
32 | /** |
||
33 | * @var bool|string |
||
34 | */ |
||
35 | private $isLoggedIn; |
||
36 | |||
37 | /** |
||
38 | * @var MediawikiSession |
||
39 | */ |
||
40 | private $session; |
||
41 | |||
42 | /** |
||
43 | * @var string |
||
44 | */ |
||
45 | private $version; |
||
46 | |||
47 | /** |
||
48 | * @var LoggerInterface |
||
49 | */ |
||
50 | private $logger; |
||
51 | |||
52 | /** |
||
53 | * @var string |
||
54 | */ |
||
55 | private $apiUrl; |
||
56 | |||
57 | /** |
||
58 | * @since 2.0 |
||
59 | * |
||
60 | * @param string $apiEndpoint e.g. https://en.wikipedia.org/w/api.php |
||
61 | * |
||
62 | * @return self returns a MediawikiApi instance using $apiEndpoint |
||
63 | */ |
||
64 | public static function newFromApiEndpoint( $apiEndpoint ) { |
||
67 | |||
68 | /** |
||
69 | * @since 2.0 |
||
70 | * |
||
71 | * @param string $url e.g. https://en.wikipedia.org OR https://de.wikipedia.org/wiki/Berlin |
||
72 | * |
||
73 | * @return self returns a MediawikiApi instance using the apiEndpoint provided by the RSD |
||
74 | * file accessible on all Mediawiki pages |
||
75 | * |
||
76 | * @see https://en.wikipedia.org/wiki/Really_Simple_Discovery |
||
77 | */ |
||
78 | 1 | public static function newFromPage( $url ) { |
|
85 | |||
86 | /** |
||
87 | * @param string $apiUrl The API Url |
||
88 | * @param ClientInterface|null $client Guzzle Client |
||
89 | * @param MediawikiSession|null $session Inject a custom session here |
||
90 | */ |
||
91 | 24 | public function __construct( $apiUrl, ClientInterface $client = null, MediawikiSession $session = null ) { |
|
105 | |||
106 | /** |
||
107 | * Get the API URL (the URL to which API requests are sent, usually ending in api.php). |
||
108 | * This is useful if you've created this object via MediawikiApi::newFromPage(). |
||
109 | * |
||
110 | * @since 2.3 |
||
111 | * |
||
112 | * @return string The API URL. |
||
113 | */ |
||
114 | public function getApiUrl() { |
||
117 | |||
118 | /** |
||
119 | * @return ClientInterface |
||
120 | */ |
||
121 | 21 | private function getClient() { |
|
122 | 21 | if( $this->client === null ) { |
|
123 | 4 | $clientFactory = new ClientFactory(); |
|
124 | 4 | $clientFactory->setLogger( $this->logger ); |
|
125 | 4 | $this->client = $clientFactory->getClient(); |
|
126 | 4 | } |
|
127 | 21 | return $this->client; |
|
128 | } |
||
129 | |||
130 | /** |
||
131 | * Sets a logger instance on the object |
||
132 | * |
||
133 | * @since 1.1 |
||
134 | * |
||
135 | * @param LoggerInterface $logger |
||
136 | * |
||
137 | * @return null |
||
138 | */ |
||
139 | public function setLogger( LoggerInterface $logger ) { |
||
143 | |||
144 | /** |
||
145 | * @since 2.0 |
||
146 | * |
||
147 | * @param Request $request |
||
148 | * |
||
149 | * @return PromiseInterface |
||
150 | * Normally promising an array, though can be mixed (json_decode result) |
||
151 | * Can throw UsageExceptions or RejectionExceptions |
||
152 | */ |
||
153 | 1 | public function getRequestAsync( Request $request ) { |
|
154 | 1 | $promise = $this->getClient()->requestAsync( |
|
155 | 1 | 'GET', |
|
156 | 1 | $this->apiUrl, |
|
157 | 1 | $this->getClientRequestOptions( $request, 'query' ) |
|
158 | 1 | ); |
|
159 | |||
160 | return $promise->then( function( ResponseInterface $response ) { |
||
161 | 1 | return call_user_func( array( $this, 'decodeResponse' ), $response ); |
|
162 | 1 | } ); |
|
163 | } |
||
164 | |||
165 | /** |
||
166 | * @since 2.0 |
||
167 | * |
||
168 | * @param Request $request |
||
169 | * |
||
170 | * @return PromiseInterface |
||
171 | * Normally promising an array, though can be mixed (json_decode result) |
||
172 | * Can throw UsageExceptions or RejectionExceptions |
||
173 | */ |
||
174 | 1 | public function postRequestAsync( Request $request ) { |
|
175 | 1 | $promise = $this->getClient()->requestAsync( |
|
176 | 1 | 'POST', |
|
177 | 1 | $this->apiUrl, |
|
178 | 1 | $this->getClientRequestOptions( $request, $this->getPostRequestEncoding( $request ) ) |
|
179 | 1 | ); |
|
180 | |||
181 | return $promise->then( function( ResponseInterface $response ) { |
||
182 | 1 | return call_user_func( array( $this, 'decodeResponse' ), $response ); |
|
183 | 1 | } ); |
|
184 | } |
||
185 | |||
186 | /** |
||
187 | * @since 0.2 |
||
188 | * |
||
189 | * @param Request $request |
||
190 | * |
||
191 | * @return mixed Normally an array |
||
192 | */ |
||
193 | 9 | public function getRequest( Request $request ) { |
|
194 | 9 | $response = $this->getClient()->request( |
|
195 | 9 | 'GET', |
|
196 | 9 | $this->apiUrl, |
|
197 | 9 | $this->getClientRequestOptions( $request, 'query' ) |
|
198 | 9 | ); |
|
199 | |||
200 | 9 | return $this->decodeResponse( $response ); |
|
201 | } |
||
202 | |||
203 | /** |
||
204 | * @since 0.2 |
||
205 | * |
||
206 | * @param Request $request |
||
207 | * |
||
208 | * @return mixed Normally an array |
||
209 | */ |
||
210 | 10 | public function postRequest( Request $request ) { |
|
211 | 10 | $response = $this->getClient()->request( |
|
212 | 10 | 'POST', |
|
213 | 10 | $this->apiUrl, |
|
214 | 10 | $this->getClientRequestOptions( $request, $this->getPostRequestEncoding( $request ) ) |
|
215 | 10 | ); |
|
216 | |||
217 | 10 | return $this->decodeResponse( $response ); |
|
218 | } |
||
219 | |||
220 | /** |
||
221 | * @param ResponseInterface $response |
||
222 | * |
||
223 | * @return mixed |
||
224 | * @throws UsageException |
||
225 | */ |
||
226 | 21 | private function decodeResponse( ResponseInterface $response ) { |
|
234 | |||
235 | /** |
||
236 | * @param Request $request |
||
237 | * |
||
238 | * @return string |
||
239 | */ |
||
240 | 9 | private function getPostRequestEncoding( Request $request ) { |
|
241 | 9 | foreach ( $request->getParams() as $value ) { |
|
242 | 9 | if ( is_resource( $value ) ) { |
|
243 | 1 | return 'multipart'; |
|
244 | } |
||
245 | 9 | } |
|
246 | 8 | return 'form_params'; |
|
247 | } |
||
248 | |||
249 | /** |
||
250 | * @param Request $request |
||
251 | * @param string $paramsKey either 'query' or 'multipart' |
||
252 | * |
||
253 | * @throws RequestException |
||
254 | * |
||
255 | * @return array as needed by ClientInterface::get and ClientInterface::post |
||
256 | */ |
||
257 | 21 | private function getClientRequestOptions( Request $request, $paramsKey ) { |
|
258 | |||
259 | 21 | $params = array_merge( $request->getParams(), array( 'format' => 'json' ) ); |
|
260 | 21 | if ( $paramsKey === 'multipart' ) { |
|
261 | 1 | $params = $this->encodeMultipartParams( $params ); |
|
262 | 1 | } |
|
263 | |||
264 | return array( |
||
265 | 21 | $paramsKey => $params, |
|
266 | 21 | 'headers' => array_merge( $this->getDefaultHeaders(), $request->getHeaders() ), |
|
267 | 21 | ); |
|
268 | } |
||
269 | |||
270 | /** |
||
271 | * @param array $params |
||
272 | * |
||
273 | * @return array |
||
274 | */ |
||
275 | 1 | private function encodeMultipartParams( $params ) { |
|
276 | |||
277 | 1 | return array_map( |
|
278 | 1 | function ( $name, $value ) { |
|
279 | |||
280 | return array( |
||
281 | 1 | 'name' => $name, |
|
282 | 1 | 'contents' => $value, |
|
283 | 1 | ); |
|
284 | 1 | }, |
|
285 | 1 | array_keys( $params ), |
|
286 | $params |
||
287 | 1 | ); |
|
288 | } |
||
289 | |||
290 | /** |
||
291 | * @return array |
||
292 | */ |
||
293 | 17 | private function getDefaultHeaders() { |
|
294 | return array( |
||
295 | 17 | 'User-Agent' => $this->getUserAgent(), |
|
296 | 17 | ); |
|
297 | } |
||
298 | |||
299 | 17 | private function getUserAgent() { |
|
306 | |||
307 | /** |
||
308 | * @param $result |
||
309 | */ |
||
310 | 17 | private function logWarnings( $result ) { |
|
311 | 17 | if( is_array( $result ) && array_key_exists( 'warnings', $result ) ) { |
|
312 | foreach( $result['warnings'] as $module => $warningData ) { |
||
313 | // Accomodate both formatversion=2 and old-style API results |
||
314 | if( isset( $warningData['*'] ) ) { |
||
315 | $this->logger->log( LogLevel::WARNING, $module . ': ' . $warningData['*'], array( 'data' => $warningData ) ); |
||
322 | |||
323 | /** |
||
324 | * @param array $result |
||
325 | * |
||
326 | * @throws UsageException |
||
327 | */ |
||
328 | 17 | private function throwUsageExceptions( $result ) { |
|
337 | |||
338 | /** |
||
339 | * @since 0.1 |
||
340 | * |
||
341 | * @return bool|string false or the name of the current user |
||
342 | */ |
||
343 | 17 | public function isLoggedin() { |
|
346 | |||
347 | /** |
||
348 | * @since 0.1 |
||
349 | * |
||
350 | * @param ApiUser $apiUser |
||
351 | * |
||
352 | * @throws UsageException |
||
353 | * @return bool success |
||
354 | */ |
||
355 | 2 | public function login( ApiUser $apiUser ) { |
|
372 | |||
373 | /** |
||
374 | * @param ApiUser $apiUser |
||
375 | * |
||
376 | * @return string[] |
||
377 | */ |
||
378 | 2 | private function getLoginParams( ApiUser $apiUser ) { |
|
389 | |||
390 | /** |
||
391 | * @param array $result |
||
392 | * |
||
393 | * @throws UsageException |
||
394 | */ |
||
395 | 1 | private function throwLoginUsageException( $result ) { |
|
406 | |||
407 | /** |
||
408 | * @since 0.1 |
||
409 | * |
||
410 | * @return bool success |
||
411 | */ |
||
412 | 2 | public function logout() { |
|
422 | |||
423 | /** |
||
424 | * @since 0.1 |
||
425 | * |
||
426 | * @param string $type |
||
427 | * |
||
428 | * @return string |
||
429 | */ |
||
430 | 2 | public function getToken( $type = 'csrf' ) { |
|
433 | |||
434 | /** |
||
435 | * @since 0.1 |
||
436 | * |
||
437 | * Clears all tokens stored by the api |
||
438 | */ |
||
439 | 1 | public function clearTokens() { |
|
442 | |||
443 | /** |
||
444 | * @return string |
||
445 | */ |
||
446 | 4 | public function getVersion(){ |
|
461 | |||
462 | } |
||
463 |