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:
Complex classes like HttplugExtension 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 HttplugExtension, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
30 | class HttplugExtension extends Extension |
||
31 | { |
||
32 | /** |
||
33 | 8 | * {@inheritdoc} |
|
34 | */ |
||
35 | 8 | public function load(array $configs, ContainerBuilder $container) |
|
36 | 8 | { |
|
37 | $configuration = $this->getConfiguration($configs, $container); |
||
38 | 8 | $config = $this->processConfiguration($configuration, $configs); |
|
1 ignored issue
–
show
|
|||
39 | |||
40 | 8 | $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config')); |
|
41 | 8 | ||
42 | $loader->load('services.xml'); |
||
43 | $loader->load('plugins.xml'); |
||
44 | 8 | ||
45 | 8 | // Register default services |
|
46 | 1 | foreach ($config['classes'] as $service => $class) { |
|
47 | 1 | if (!empty($class)) { |
|
48 | 8 | $container->register(sprintf('httplug.%s.default', $service), $class); |
|
49 | } |
||
50 | } |
||
51 | 8 | ||
52 | 8 | // Set main aliases |
|
53 | 8 | foreach ($config['main_alias'] as $type => $id) { |
|
54 | $container->setAlias(sprintf('httplug.%s', $type), $id); |
||
55 | } |
||
56 | 8 | ||
57 | 5 | // Configure toolbar |
|
58 | if ($this->isConfigEnabled($container, $config['profiling'])) { |
||
59 | 5 | $loader->load('data-collector.xml'); |
|
60 | |||
61 | if (!empty($config['profiling']['formatter'])) { |
||
62 | // Add custom formatter |
||
63 | $container |
||
64 | ->getDefinition('httplug.collector.debug_collector') |
||
65 | ->replaceArgument(0, new Reference($config['profiling']['formatter'])) |
||
66 | ; |
||
67 | } |
||
68 | 5 | ||
69 | 5 | $container |
|
70 | ->getDefinition('httplug.formatter.full_http_message') |
||
71 | 5 | ->addArgument($config['profiling']['captured_body_length']) |
|
72 | ; |
||
73 | 8 | } |
|
74 | 8 | ||
75 | 8 | $this->configureClients($container, $config); |
|
76 | 8 | $this->configureSharedPlugins($container, $config['plugins']); // must be after clients, as clients.X.plugins might use plugins as templates that will be removed |
|
77 | $this->configureAutoDiscoveryClients($container, $config); |
||
78 | } |
||
79 | |||
80 | /** |
||
81 | * Configure client services. |
||
82 | * |
||
83 | * @param ContainerBuilder $container |
||
84 | 8 | * @param array $config |
|
85 | */ |
||
86 | 8 | private function configureClients(ContainerBuilder $container, array $config) |
|
108 | |||
109 | /** |
||
110 | * @param ContainerBuilder $container |
||
111 | 8 | * @param array $config |
|
112 | */ |
||
113 | 8 | private function configureSharedPlugins(ContainerBuilder $container, array $config) |
|
114 | { |
||
115 | if (!empty($config['authentication'])) { |
||
116 | 8 | $this->configureAuthentication($container, $config['authentication']); |
|
117 | } |
||
118 | 8 | unset($config['authentication']); |
|
119 | 8 | ||
120 | foreach ($config as $name => $pluginConfig) { |
||
121 | 8 | $pluginId = 'httplug.plugin.'.$name; |
|
122 | 8 | ||
123 | 8 | if ($this->isConfigEnabled($container, $pluginConfig)) { |
|
124 | 8 | $def = $container->getDefinition($pluginId); |
|
125 | 8 | $this->configurePluginByName($name, $def, $pluginConfig, $container, $pluginId); |
|
126 | } else { |
||
127 | 8 | $container->removeDefinition($pluginId); |
|
128 | 8 | } |
|
129 | } |
||
130 | } |
||
131 | |||
132 | /** |
||
133 | * @param string $name |
||
134 | * @param Definition $definition |
||
135 | 8 | * @param array $config |
|
136 | * @param ContainerBuilder $container In case we need to add additional services for this plugin |
||
137 | * @param string $serviceId Service id of the plugin, in case we need to add additional services for this plugin. |
||
138 | 8 | */ |
|
139 | private function configurePluginByName($name, Definition $definition, array $config, ContainerInterface $container, $serviceId) |
||
140 | { |
||
141 | switch ($name) { |
||
142 | case 'cache': |
||
143 | $definition |
||
144 | 8 | ->replaceArgument(0, new Reference($config['cache_pool'])) |
|
145 | ->replaceArgument(1, new Reference($config['stream_factory'])) |
||
146 | ->replaceArgument(2, $config['config']); |
||
147 | 8 | break; |
|
148 | 8 | case 'cookie': |
|
149 | 8 | $definition->replaceArgument(0, new Reference($config['cookie_jar'])); |
|
150 | 8 | break; |
|
151 | case 'decoder': |
||
152 | $definition->addArgument([ |
||
153 | 8 | 'use_content_encoding' => $config['use_content_encoding'], |
|
154 | 8 | ]); |
|
155 | 8 | break; |
|
156 | case 'history': |
||
157 | $definition->replaceArgument(0, new Reference($config['journal'])); |
||
158 | 8 | break; |
|
159 | 8 | case 'logger': |
|
160 | $definition->replaceArgument(0, new Reference($config['logger'])); |
||
161 | 8 | if (!empty($config['formatter'])) { |
|
162 | 8 | $definition->replaceArgument(1, new Reference($config['formatter'])); |
|
163 | 8 | } |
|
164 | 8 | break; |
|
165 | 8 | case 'redirect': |
|
166 | 8 | $definition->addArgument([ |
|
167 | 8 | 'preserve_header' => $config['preserve_header'], |
|
168 | 8 | 'use_default_for_multiple' => $config['use_default_for_multiple'], |
|
169 | 8 | ]); |
|
170 | break; |
||
171 | 8 | case 'retry': |
|
172 | $definition->addArgument([ |
||
173 | 'retries' => $config['retry'], |
||
174 | ]); |
||
175 | break; |
||
176 | case 'stopwatch': |
||
177 | $definition->replaceArgument(0, new Reference($config['stopwatch'])); |
||
178 | break; |
||
179 | |||
180 | /* client specific plugins */ |
||
181 | |||
182 | case 'add_host': |
||
183 | $uriService = $serviceId.'.host_uri'; |
||
184 | $this->createUri($container, $uriService, $config['host']); |
||
185 | $definition->replaceArgument(0, new Reference($uriService)); |
||
186 | $definition->replaceArgument(1, [ |
||
187 | 'replace' => $config['replace'], |
||
188 | ]); |
||
189 | break; |
||
190 | |||
191 | default: |
||
192 | throw new \InvalidArgumentException(sprintf('Internal exception: Plugin %s is not handled', $name)); |
||
193 | } |
||
194 | } |
||
195 | |||
196 | /** |
||
197 | * @param ContainerBuilder $container |
||
198 | * @param array $config |
||
199 | */ |
||
200 | private function configureAuthentication(ContainerBuilder $container, array $config) |
||
201 | { |
||
202 | foreach ($config as $name => $values) { |
||
203 | $authServiceKey = sprintf('httplug.plugin.authentication.%s.auth', $name); |
||
204 | switch ($values['type']) { |
||
205 | case 'bearer': |
||
206 | $container->register($authServiceKey, Bearer::class) |
||
207 | ->addArgument($values['token']); |
||
208 | break; |
||
209 | case 'basic': |
||
210 | $container->register($authServiceKey, BasicAuth::class) |
||
211 | ->addArgument($values['username']) |
||
212 | ->addArgument($values['password']); |
||
213 | break; |
||
214 | case 'wsse': |
||
215 | $container->register($authServiceKey, Wsse::class) |
||
216 | ->addArgument($values['username']) |
||
217 | ->addArgument($values['password']); |
||
218 | break; |
||
219 | case 'service': |
||
220 | $authServiceKey = $values['service']; |
||
221 | break; |
||
222 | default: |
||
223 | throw new \LogicException(sprintf('Unknown authentication type: "%s"', $values['type'])); |
||
224 | } |
||
225 | |||
226 | $container->register('httplug.plugin.authentication.'.$name, AuthenticationPlugin::class) |
||
227 | ->addArgument(new Reference($authServiceKey)); |
||
228 | } |
||
229 | } |
||
230 | |||
231 | /** |
||
232 | * @param ContainerBuilder $container |
||
233 | * @param string $clientName |
||
234 | * @param array $arguments |
||
235 | * @param bool $profiling |
||
236 | */ |
||
237 | private function configureClient(ContainerBuilder $container, $clientName, array $arguments, $profiling) |
||
238 | { |
||
239 | $serviceId = 'httplug.client.'.$clientName; |
||
240 | |||
241 | $plugins = []; |
||
242 | foreach ($arguments['plugins'] as $plugin) { |
||
243 | list($pluginName, $pluginConfig) = each($plugin); |
||
244 | if ('reference' === $pluginName) { |
||
245 | $plugins[] = $pluginConfig['id']; |
||
246 | } elseif ('authentication' === $pluginName) { |
||
247 | // TODO handle custom authentication |
||
248 | } else { |
||
249 | $pluginServiceId = $serviceId.'.plugin.'.$pluginName; |
||
250 | $def = clone $container->getDefinition('httplug.plugin'.'.'.$pluginName); |
||
251 | $def->setAbstract(false); |
||
252 | $this->configurePluginByName($pluginName, $def, $pluginConfig, $container, $pluginServiceId); |
||
253 | $container->setDefinition($pluginServiceId, $def); |
||
254 | $plugins[] = $pluginServiceId; |
||
255 | } |
||
256 | } |
||
257 | |||
258 | $pluginClientOptions = []; |
||
259 | if ($profiling) { |
||
260 | // Add the stopwatch plugin |
||
261 | if (!in_array('httplug.plugin.stopwatch', $arguments['plugins'])) { |
||
262 | array_unshift($plugins, 'httplug.plugin.stopwatch'); |
||
263 | } |
||
264 | |||
265 | // Tell the plugin journal what plugins we used |
||
266 | $container |
||
267 | ->getDefinition('httplug.collector.plugin_journal') |
||
268 | ->addMethodCall('setPlugins', [$clientName, $plugins]) |
||
269 | ; |
||
270 | |||
271 | $debugPluginServiceId = $this->registerDebugPlugin($container, $serviceId); |
||
272 | |||
273 | $pluginClientOptions['debug_plugins'] = [new Reference($debugPluginServiceId)]; |
||
274 | } |
||
275 | |||
276 | $container |
||
277 | ->register($serviceId, DummyClient::class) |
||
278 | ->setFactory([PluginClientFactory::class, 'createPluginClient']) |
||
279 | ->addArgument( |
||
280 | array_map( |
||
281 | function ($id) { |
||
282 | return new Reference($id); |
||
283 | }, |
||
284 | $plugins |
||
285 | ) |
||
286 | ) |
||
287 | ->addArgument(new Reference($arguments['factory'])) |
||
288 | ->addArgument($arguments['config']) |
||
289 | ->addArgument($pluginClientOptions) |
||
290 | ; |
||
291 | |||
292 | |||
293 | /* |
||
294 | * Decorate the client with clients from client-common |
||
295 | */ |
||
296 | View Code Duplication | if ($arguments['flexible_client']) { |
|
297 | $container |
||
298 | ->register($serviceId.'.flexible', FlexibleHttpClient::class) |
||
299 | ->addArgument(new Reference($serviceId.'.flexible.inner')) |
||
300 | ->setPublic(false) |
||
301 | ->setDecoratedService($serviceId) |
||
302 | ; |
||
303 | } |
||
304 | |||
305 | View Code Duplication | if ($arguments['http_methods_client']) { |
|
306 | $container |
||
307 | ->register($serviceId.'.http_methods', HttpMethodsClient::class) |
||
308 | ->setArguments([new Reference($serviceId.'.http_methods.inner'), new Reference('httplug.message_factory')]) |
||
309 | ->setPublic(false) |
||
310 | ->setDecoratedService($serviceId) |
||
311 | ; |
||
312 | } |
||
313 | |||
314 | View Code Duplication | if ($arguments['batch_client']) { |
|
315 | $container |
||
316 | ->register($serviceId.'.batch_client', BatchClient::class) |
||
317 | ->setArguments([new Reference($serviceId.'.batch_client.inner')]) |
||
318 | ->setPublic(false) |
||
319 | ->setDecoratedService($serviceId) |
||
320 | ; |
||
321 | } |
||
322 | } |
||
323 | |||
324 | /** |
||
325 | * Create a URI object with the default URI factory. |
||
326 | * |
||
327 | * @param ContainerBuilder $container |
||
328 | * @param string $serviceId Name of the private service to create |
||
329 | * @param string $uri String representation of the URI |
||
330 | */ |
||
331 | private function createUri(ContainerBuilder $container, $serviceId, $uri) |
||
332 | { |
||
333 | $container |
||
334 | ->register($serviceId, UriInterface::class) |
||
335 | ->setPublic(false) |
||
336 | ->setFactory([new Reference('httplug.uri_factory'), 'createUri']) |
||
337 | ->addArgument($uri) |
||
338 | ; |
||
339 | } |
||
340 | |||
341 | /** |
||
342 | * Make the user can select what client is used for auto discovery. If none is provided, a service will be created |
||
343 | * by finding a client using auto discovery. |
||
344 | * |
||
345 | * @param ContainerBuilder $container |
||
346 | * @param array $config |
||
347 | */ |
||
348 | private function configureAutoDiscoveryClients(ContainerBuilder $container, array $config) |
||
349 | { |
||
350 | $httpClient = $config['discovery']['client']; |
||
351 | |||
352 | View Code Duplication | if (!empty($httpClient)) { |
|
353 | if ($httpClient === 'auto') { |
||
354 | $httpClient = $this->registerAutoDiscoverableClient( |
||
355 | $container, |
||
356 | 'auto_discovered_client', |
||
357 | [HttpClientDiscovery::class, 'find'], |
||
358 | $this->isConfigEnabled($container, $config['profiling']) |
||
359 | ); |
||
360 | } |
||
361 | |||
362 | $httpClient = new Reference($httpClient); |
||
363 | } |
||
364 | |||
365 | $asyncHttpClient = $config['discovery']['async_client']; |
||
366 | |||
367 | View Code Duplication | if (!empty($asyncHttpClient)) { |
|
368 | if ($asyncHttpClient === 'auto') { |
||
369 | $asyncHttpClient = $this->registerAutoDiscoverableClient( |
||
370 | $container, |
||
371 | 'auto_discovered_async', |
||
372 | [HttpAsyncClientDiscovery::class, 'find'], |
||
373 | $this->isConfigEnabled($container, $config['profiling']) |
||
374 | ); |
||
375 | } |
||
376 | |||
377 | $asyncHttpClient = new Reference($asyncHttpClient); |
||
378 | } |
||
379 | |||
380 | $container |
||
381 | ->getDefinition('httplug.strategy') |
||
382 | ->addArgument($httpClient) |
||
383 | ->addArgument($asyncHttpClient) |
||
384 | ; |
||
385 | } |
||
386 | |||
387 | /** |
||
388 | * Find a client with auto discovery and return a service Reference to it. |
||
389 | * |
||
390 | * @param ContainerBuilder $container |
||
391 | * @param string $name |
||
392 | * @param callable $factory |
||
393 | * @param bool $profiling |
||
394 | * |
||
395 | * @return string service id |
||
396 | */ |
||
397 | private function registerAutoDiscoverableClient(ContainerBuilder $container, $name, $factory, $profiling) |
||
423 | |||
424 | /** |
||
425 | * Create a new plugin service for this client. |
||
426 | * |
||
427 | * @param ContainerBuilder $container |
||
428 | * @param string $serviceId |
||
429 | * |
||
430 | * @return string |
||
431 | */ |
||
432 | private function registerDebugPlugin(ContainerBuilder $container, $serviceId) |
||
445 | |||
446 | /** |
||
447 | * {@inheritdoc} |
||
448 | */ |
||
449 | public function getConfiguration(array $config, ContainerBuilder $container) |
||
453 | } |
||
454 |
Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: