HttplugExtension::configureSharedPlugins() - Code Metrics - Inspection of "[WIP] Allow to configure plugins specifically for..." - php-http/HttplugBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#112)

by David

created 2016-08-11 11:21 UTC

HttplugExtension::configureSharedPlugins() A

↳ Parent: HttplugExtension

Complexity

Conditions	4
Paths	6

Size

Total Lines	18
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	4.0582

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	18
ccs	11
cts	13
cp	0.8462
rs	9.2
cc	4
eloc	11
nc	6
nop	2
crap	4.0582

<?php

namespace Http\HttplugBundle\DependencyInjection;

use Http\Client\Common\BatchClient;
use Http\Client\Common\FlexibleHttpClient;
use Http\Client\Common\HttpMethodsClient;
use Http\Client\Common\Plugin\AuthenticationPlugin;
use Http\Discovery\HttpAsyncClientDiscovery;
use Http\Discovery\HttpClientDiscovery;
use Http\HttplugBundle\ClientFactory\DummyClient;
use Http\HttplugBundle\ClientFactory\PluginClientFactory;
use Http\HttplugBundle\Collector\DebugPlugin;
use Http\Message\Authentication\BasicAuth;
use Http\Message\Authentication\Bearer;
use Http\Message\Authentication\Wsse;
use Psr\Http\Message\UriInterface;
use Symfony\Component\Config\FileLocator;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\DependencyInjection\Definition;
use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
use Symfony\Component\DependencyInjection\Reference;
use Symfony\Component\HttpKernel\DependencyInjection\Extension;

/**
 * @author David Buchmann <[email protected]>
 * @author Tobias Nyholm <[email protected]>
 */
class HttplugExtension extends Extension
{
    /**
     * {@inheritdoc}
     */
    public function load(array $configs, ContainerBuilder $container)
    {
        $configuration = $this->getConfiguration($configs, $container);
        $config = $this->processConfiguration($configuration, $configs);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}

        $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));

        $loader->load('services.xml');
        $loader->load('plugins.xml');

        // Register default services
        foreach ($config['classes'] as $service => $class) {
            if (!empty($class)) {
                $container->register(sprintf('httplug.%s.default', $service), $class);
            }
        }

        // Set main aliases
        foreach ($config['main_alias'] as $type => $id) {
            $container->setAlias(sprintf('httplug.%s', $type), $id);
        }

        // Configure toolbar
        if ($config['profiling']['enabled']) {
            $loader->load('data-collector.xml');

            if (!empty($config['profiling']['formatter'])) {
                // Add custom formatter
                $container
                    ->getDefinition('httplug.collector.debug_collector')
                    ->replaceArgument(0, new Reference($config['profiling']['formatter']))
                ;
            }

            $container
                ->getDefinition('httplug.formatter.full_http_message')
                ->addArgument($config['profiling']['captured_body_length'])
            ;
        }

        $this->configureClients($container, $config);
        $this->configureSharedPlugins($container, $config['plugins']); // must be after clients, as the extra_plugins in clients might use plugins as template that will be removed
        $this->configureAutoDiscoveryClients($container, $config);
    }

    /**
     * Configure client services.
     *
     * @param ContainerBuilder $container
     * @param array            $config
     */
    private function configureClients(ContainerBuilder $container, array $config)
    {
        $first = null;

        foreach ($config['clients'] as $name => $arguments) {
            if ($first === null) {
                // Save the name of the first configurated client.
                $first = $name;
            }

            $this->configureClient($container, $name, $arguments, $config['profiling']['enabled']);
        }

        // If we have clients configured
        if ($first !== null) {
            // If we do not have a client named 'default'
            if (!isset($config['clients']['default'])) {
                // Alias the first client to httplug.client.default
                $container->setAlias('httplug.client.default', 'httplug.client.'.$first);
            }
        }
    }

    /**
     * @param ContainerBuilder $container
     * @param array            $config
     */
    private function configureSharedPlugins(ContainerBuilder $container, array $config)
    {
        if (!empty($config['authentication'])) {
            $this->configureAuthentication($container, $config['authentication']);
        }
        unset($config['authentication']);

        foreach ($config as $name => $pluginConfig) {
            $pluginId = 'httplug.plugin.'.$name;

            if ($pluginConfig['enabled']) {
                $def = $container->getDefinition($pluginId);
                $this->configurePluginByName($name, $def, $pluginConfig, $container, $pluginId);
            } else {
                $container->removeDefinition($pluginId);
            }
        }
    }

    /**
     * @param string           $name
     * @param Definition       $definition
     * @param array            $config
     * @param ContainerBuilder $container  In case we need to add additional services for this plugin
     * @param string           $serviceId  Service id of the plugin, in case we need to add additional services for this plugin.
     */
    private function configurePluginByName($name, Definition $definition, array $config, ContainerInterface $container, $serviceId)
    {
        switch ($name) {
            case 'cache':
                $definition
                    ->replaceArgument(0, new Reference($config['cache_pool']))
                    ->replaceArgument(1, new Reference($config['stream_factory']))
                    ->replaceArgument(2, $config['config']);
                break;
            case 'cookie':
                $definition->replaceArgument(0, new Reference($config['cookie_jar']));
                break;
            case 'decoder':
                $definition->addArgument([
                    'use_content_encoding' => $config['use_content_encoding'],
                ]);
                break;
            case 'history':
                $definition->replaceArgument(0, new Reference($config['journal']));
                break;
            case 'logger':
                $definition->replaceArgument(0, new Reference($config['logger']));
                if (!empty($config['formatter'])) {
                    $definition->replaceArgument(1, new Reference($config['formatter']));
                }
                break;
            case 'redirect':
                $definition->addArgument([
                    'preserve_header' => $config['preserve_header'],
                    'use_default_for_multiple' => $config['use_default_for_multiple'],
                ]);
                break;
            case 'retry':
                $definition->addArgument([
                    'retries' => $config['retry'],
                ]);
                break;
            case 'stopwatch':
                $definition->replaceArgument(0, new Reference($config['stopwatch']));
                break;

            /* client specific plugins */

            case 'add_host':
                $uriService = $serviceId.'.host_uri';
                $this->createUri($container, $uriService, $config['host']);

                $definition->replaceArgument(0, new Reference($uriService));
                $definition->replaceArgument(1, [
                    'replace' => $config['replace'],
                ]);
                break;

            default:
                throw new \InvalidArgumentException(sprintf('Internal exception: Plugin %s is not handled', $name));
        }
    }

    /**
     * @param ContainerBuilder $container
     * @param array            $config
     */
    private function configureAuthentication(ContainerBuilder $container, array $config)
    {
        foreach ($config as $name => $values) {
            $authServiceKey = sprintf('httplug.plugin.authentication.%s.auth', $name);
            switch ($values['type']) {
                case 'bearer':
                    $container->register($authServiceKey, Bearer::class)
                        ->addArgument($values['token']);
                    break;
                case 'basic':
                    $container->register($authServiceKey, BasicAuth::class)
                        ->addArgument($values['username'])
                        ->addArgument($values['password']);
                    break;
                case 'wsse':
                    $container->register($authServiceKey, Wsse::class)
                        ->addArgument($values['username'])
                        ->addArgument($values['password']);
                    break;
                case 'service':
                    $authServiceKey = $values['service'];
                    break;
                default:
                    throw new \LogicException(sprintf('Unknown authentication type: "%s"', $values['type']));
            }

            $container->register('httplug.plugin.authentication.'.$name, AuthenticationPlugin::class)
                ->addArgument(new Reference($authServiceKey));
        }
    }

    /**
     * @param ContainerBuilder $container
     * @param string           $name
     * @param array            $arguments
     * @param bool             $profiling
     */
    private function configureClient(ContainerBuilder $container, $name, array $arguments, $profiling)
    {
        $serviceId = 'httplug.client.'.$name;

        $pluginClientOptions = [];

        if ($profiling) {
            if (!in_array('httplug.plugin.stopwatch', $arguments['plugins'])) {
                // Add the stopwatch plugin
                array_unshift($arguments['plugins'], [
                    'reference' => [
                        'id' => 'httplug.plugin.stopwatch',
                    ],
                ]);
            }

            // Tell the plugin journal what plugins we used
            $container
                ->getDefinition('httplug.collector.plugin_journal')
                ->addMethodCall('setPlugins', [$name, $arguments['plugins']])
            ;

            $debugPluginServiceId = $this->registerDebugPlugin($container, $serviceId);

            $pluginClientOptions['debug_plugins'] = [new Reference($debugPluginServiceId)];
        }

        $plugins = [];
        foreach ($arguments['plugins'] as $plugin) {
            list($name, $pluginConfig) = each($plugin);
            if ('reference' === $name) {
                $plugins[] = $pluginConfig['id'];
            } elseif ('authentication' === $name) {

                // TODO handle custom authentication
            } else {
                $pluginServiceId = $serviceId.'.plugin.'.$name;
                $def = clone $container->getDefinition('httplug.plugin'.'.'.$name);
                $def->setAbstract(false);
                $this->configurePluginByName($name, $def, $pluginConfig, $container, $pluginServiceId);
                $container->setDefinition($pluginServiceId, $def);
                $plugins[] = $pluginServiceId;
            }
        }

        $container
            ->register($serviceId, DummyClient::class)
            ->setFactory([PluginClientFactory::class, 'createPluginClient'])
            ->addArgument(
                array_map(
                    function ($id) {
                        return new Reference($id);
                    },
                    $plugins
                )
            )
            ->addArgument(new Reference($arguments['factory']))
            ->addArgument($arguments['config'])
            ->addArgument($pluginClientOptions)
        ;


        /*
         * Decorate the client with clients from client-common
         */
        if ($arguments['flexible_client']) {

            $container
                ->register($serviceId.'.flexible', FlexibleHttpClient::class)
                ->addArgument(new Reference($serviceId.'.flexible.inner'))
                ->setPublic(false)
                ->setDecoratedService($serviceId)
            ;
        }

        if ($arguments['http_methods_client']) {

            $container
                ->register($serviceId.'.http_methods', HttpMethodsClient::class)
                ->setArguments([new Reference($serviceId.'.http_methods.inner'), new Reference('httplug.message_factory')])
                ->setPublic(false)
                ->setDecoratedService($serviceId)
            ;
        }

        if ($arguments['batch_client']) {

            $container
                ->register($serviceId.'.batch_client', BatchClient::class)
                ->setArguments([new Reference($serviceId.'.batch_client.inner')])
                ->setPublic(false)
                ->setDecoratedService($serviceId)
            ;
        }
    }

    /**
     * Create a URI object with the default URI factory.
     *
     * @param ContainerBuilder $container
     * @param string           $serviceId Name of the private service to create
     * @param string           $uri       String representation of the URI
     */
    private function createUri(ContainerBuilder $container, $serviceId, $uri)
    {
        $container
            ->register($serviceId, UriInterface::class)
            ->setPublic(false)
            ->setFactory([new Reference('httplug.uri_factory'), 'createUri'])
            ->addArgument($uri)
        ;
    }

    /**
     * Make the user can select what client is used for auto discovery. If none is provided, a service will be created
     * by finding a client using auto discovery.
     *
     * @param ContainerBuilder $container
     * @param array            $config
     */
    private function configureAutoDiscoveryClients(ContainerBuilder $container, array $config)
    {
        $httpClient = $config['discovery']['client'];

        if (!empty($httpClient)) {

            if ($httpClient === 'auto') {
                $httpClient = $this->registerAutoDiscoverableClient(
                    $container,
                    'auto_discovered_client',
                    [HttpClientDiscovery::class, 'find'],
                    $config['profiling']['enabled']
                );
            }

            $httpClient = new Reference($httpClient);
        }

        $asyncHttpClient = $config['discovery']['async_client'];

        if (!empty($asyncHttpClient)) {

            if ($asyncHttpClient === 'auto') {
                $asyncHttpClient = $this->registerAutoDiscoverableClient(
                    $container,
                    'auto_discovered_async',
                    [HttpAsyncClientDiscovery::class, 'find'],
                    $config['profiling']['enabled']
                );
            }

            $asyncHttpClient = new Reference($asyncHttpClient);
        }

        $container
            ->getDefinition('httplug.strategy')
            ->addArgument($httpClient)
            ->addArgument($asyncHttpClient)
        ;
    }

    /**
     * Find a client with auto discovery and return a service Reference to it.
     *
     * @param ContainerBuilder $container
     * @param string           $name
     * @param callable         $factory
     * @param bool             $profiling
     *
     * @return string service id
     */
    private function registerAutoDiscoverableClient(ContainerBuilder $container, $name, $factory, $profiling)
    {
        $serviceId = 'httplug.auto_discovery.'.$name;

        $pluginClientOptions = [];

        if ($profiling) {
            // Tell the plugin journal what plugins we used
            $container
                ->getDefinition('httplug.collector.plugin_journal')
                ->addMethodCall('setPlugins', [$name, ['httplug.plugin.stopwatch']])
            ;

            $debugPluginServiceId = $this->registerDebugPlugin($container, $serviceId);

            $pluginClientOptions['debug_plugins'] = [new Reference($debugPluginServiceId)];
        }

        $container
            ->register($serviceId, DummyClient::class)
            ->setFactory([PluginClientFactory::class, 'createPluginClient'])
            ->setArguments([[new Reference('httplug.plugin.stopwatch')], $factory, [], $pluginClientOptions])
        ;

        return $serviceId;
    }

    /**
     * Create a new plugin service for this client.
     *
     * @param ContainerBuilder $container
     * @param string           $serviceId
     *
     * @return string
     */
    private function registerDebugPlugin(ContainerBuilder $container, $serviceId)
    {
        $serviceIdDebugPlugin = $serviceId.'.debug_plugin';

        $container
            ->register($serviceIdDebugPlugin, DebugPlugin::class)
            ->addArgument(new Reference('httplug.collector.debug_collector'))
            ->addArgument(substr($serviceId, strrpos($serviceId, '.') + 1))
            ->setPublic(false)
        ;

        return $serviceIdDebugPlugin;
    }

    /**
     * {@inheritdoc}
     */
    public function getConfiguration(array $config, ContainerBuilder $container)
    {
        return new Configuration($container->getParameter('kernel.debug'));
    }
}


1			<?php
2
3			namespace Http\HttplugBundle\DependencyInjection;
4
5			use Http\Client\Common\BatchClient;
6			use Http\Client\Common\FlexibleHttpClient;
7			use Http\Client\Common\HttpMethodsClient;
8			use Http\Client\Common\Plugin\AuthenticationPlugin;
9			use Http\Discovery\HttpAsyncClientDiscovery;
10			use Http\Discovery\HttpClientDiscovery;
11			use Http\HttplugBundle\ClientFactory\DummyClient;
12			use Http\HttplugBundle\ClientFactory\PluginClientFactory;
13			use Http\HttplugBundle\Collector\DebugPlugin;
14			use Http\Message\Authentication\BasicAuth;
15			use Http\Message\Authentication\Bearer;
16			use Http\Message\Authentication\Wsse;
17			use Psr\Http\Message\UriInterface;
18			use Symfony\Component\Config\FileLocator;
19			use Symfony\Component\DependencyInjection\ContainerBuilder;
20			use Symfony\Component\DependencyInjection\ContainerInterface;
21			use Symfony\Component\DependencyInjection\Definition;
22			use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
23			use Symfony\Component\DependencyInjection\Reference;
24			use Symfony\Component\HttpKernel\DependencyInjection\Extension;
25
26			/**
27			* @author David Buchmann <[email protected]>
28			* @author Tobias Nyholm <[email protected]>
29			*/
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 Bug introduced 2016-07-24 10:10 UTC by Report Bug Copy Issue Report It seems like `$configuration` defined by `$this->getConfiguration($configs, $container)` on line `37` can be `null`; however, `Symfony\Component\Depend...:processConfiguration()` does not accept `null`, maybe add an additional type check? 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: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
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 ($config['profiling']['enabled']) {
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 the extra_plugins in clients might use plugins as template 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)
87			{
88	8		$first = null;
89	3
90			foreach ($config['clients'] as $name => $arguments) {
91	3		if ($first === null) {
92	3		// Save the name of the first configurated client.
93			$first = $name;
94	3		}
95	8
96			$this->configureClient($container, $name, $arguments, $config['profiling']['enabled']);
97			}
98	8
99			// If we have clients configured
100	3		if ($first !== null) {
101			// If we do not have a client named 'default'
102	3		if (!isset($config['clients']['default'])) {
103	3		// Alias the first client to httplug.client.default
104	3		$container->setAlias('httplug.client.default', 'httplug.client.'.$first);
105	8		}
106			}
107			}
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 ($pluginConfig['enabled']) {
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']);
			0 ignored issues – show Compatibility introduced 2016-08-07 11:00 UTC by Report Bug Copy Issue Report `$container` of type `object<Symfony\Component...ion\ContainerInterface>` is not a sub-type of `object<Symfony\Component...ction\ContainerBuilder>`. It seems like you assume a concrete implementation of the interface `Symfony\Component\Depend...tion\ContainerInterface` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
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 $name
234			* @param array $arguments
235			* @param bool $profiling
236			*/
237			private function configureClient(ContainerBuilder $container, $name, array $arguments, $profiling)
238			{
239			$serviceId = 'httplug.client.'.$name;
240
241			$pluginClientOptions = [];
242
243			if ($profiling) {
244			if (!in_array('httplug.plugin.stopwatch', $arguments['plugins'])) {
245			// Add the stopwatch plugin
246			array_unshift($arguments['plugins'], [
247			'reference' => [
248			'id' => 'httplug.plugin.stopwatch',
249			],
250			]);
251			}
252
253			// Tell the plugin journal what plugins we used
254			$container
255			->getDefinition('httplug.collector.plugin_journal')
256			->addMethodCall('setPlugins', [$name, $arguments['plugins']])
257			;
258
259			$debugPluginServiceId = $this->registerDebugPlugin($container, $serviceId);
260
261			$pluginClientOptions['debug_plugins'] = [new Reference($debugPluginServiceId)];
262			}
263
264			$plugins = [];
265			foreach ($arguments['plugins'] as $plugin) {
266			list($name, $pluginConfig) = each($plugin);
267			if ('reference' === $name) {
268			$plugins[] = $pluginConfig['id'];
269			} elseif ('authentication' === $name) {
			0 ignored issues – show Unused Code introduced 2016-08-11 07:00 UTC by Report Bug Copy Issue Report This `elseif` statement is empty, and could be removed. This check looks for the bodies of `elseif` statements that have no statements or where all statements have been commented out. This may be the result of changes for debugging or the code may simply be obsolete. These `elseif` bodies can be removed. If you have an empty elseif but statements in the `else` branch, consider inverting the condition. Loading history...
270			// TODO handle custom authentication
271			} else {
272			$pluginServiceId = $serviceId.'.plugin.'.$name;
273			$def = clone $container->getDefinition('httplug.plugin'.'.'.$name);
274			$def->setAbstract(false);
275			$this->configurePluginByName($name, $def, $pluginConfig, $container, $pluginServiceId);
276			$container->setDefinition($pluginServiceId, $def);
277			$plugins[] = $pluginServiceId;
278			}
279			}
280
281			$container
282			->register($serviceId, DummyClient::class)
283			->setFactory([PluginClientFactory::class, 'createPluginClient'])
284			->addArgument(
285			array_map(
286			function ($id) {
287			return new Reference($id);
288			},
289			$plugins
290			)
291			)
292			->addArgument(new Reference($arguments['factory']))
293			->addArgument($arguments['config'])
294			->addArgument($pluginClientOptions)
295			;
296
297
298			/*
299			* Decorate the client with clients from client-common
300			*/
301		View Code Duplication	if ($arguments['flexible_client']) {
			0 ignored issues – show Duplication introduced 2016-06-29 21:35 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. 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. Loading history...
302			$container
303			->register($serviceId.'.flexible', FlexibleHttpClient::class)
304			->addArgument(new Reference($serviceId.'.flexible.inner'))
305			->setPublic(false)
306			->setDecoratedService($serviceId)
307			;
308			}
309
310		View Code Duplication	if ($arguments['http_methods_client']) {
			0 ignored issues – show Duplication introduced 2016-06-30 08:00 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. 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. Loading history...
311			$container
312			->register($serviceId.'.http_methods', HttpMethodsClient::class)
313			->setArguments([new Reference($serviceId.'.http_methods.inner'), new Reference('httplug.message_factory')])
314			->setPublic(false)
315			->setDecoratedService($serviceId)
316			;
317			}
318
319		View Code Duplication	if ($arguments['batch_client']) {
			0 ignored issues – show Duplication introduced 2016-07-25 01:44 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. 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. Loading history...
320			$container
321			->register($serviceId.'.batch_client', BatchClient::class)
322			->setArguments([new Reference($serviceId.'.batch_client.inner')])
323			->setPublic(false)
324			->setDecoratedService($serviceId)
325			;
326			}
327			}
328
329			/**
330			* Create a URI object with the default URI factory.
331			*
332			* @param ContainerBuilder $container
333			* @param string $serviceId Name of the private service to create
334			* @param string $uri String representation of the URI
335			*/
336			private function createUri(ContainerBuilder $container, $serviceId, $uri)
337			{
338			$container
339			->register($serviceId, UriInterface::class)
340			->setPublic(false)
341			->setFactory([new Reference('httplug.uri_factory'), 'createUri'])
342			->addArgument($uri)
343			;
344			}
345
346			/**
347			* Make the user can select what client is used for auto discovery. If none is provided, a service will be created
348			* by finding a client using auto discovery.
349			*
350			* @param ContainerBuilder $container
351			* @param array $config
352			*/
353			private function configureAutoDiscoveryClients(ContainerBuilder $container, array $config)
354			{
355			$httpClient = $config['discovery']['client'];
356
357		View Code Duplication	if (!empty($httpClient)) {
			0 ignored issues – show Duplication introduced 2016-07-20 16:14 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. 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. Loading history...
358			if ($httpClient === 'auto') {
359			$httpClient = $this->registerAutoDiscoverableClient(
360			$container,
361			'auto_discovered_client',
362			[HttpClientDiscovery::class, 'find'],
363			$config['profiling']['enabled']
364			);
365			}
366
367			$httpClient = new Reference($httpClient);
368			}
369
370			$asyncHttpClient = $config['discovery']['async_client'];
371
372		View Code Duplication	if (!empty($asyncHttpClient)) {
			0 ignored issues – show Duplication introduced 2016-07-20 16:14 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. 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. Loading history...
373			if ($asyncHttpClient === 'auto') {
374			$asyncHttpClient = $this->registerAutoDiscoverableClient(
375			$container,
376			'auto_discovered_async',
377			[HttpAsyncClientDiscovery::class, 'find'],
378			$config['profiling']['enabled']
379			);
380			}
381
382			$asyncHttpClient = new Reference($asyncHttpClient);
383			}
384
385			$container
386			->getDefinition('httplug.strategy')
387			->addArgument($httpClient)
388			->addArgument($asyncHttpClient)
389			;
390			}
391
392			/**
393			* Find a client with auto discovery and return a service Reference to it.
394			*
395			* @param ContainerBuilder $container
396			* @param string $name
397			* @param callable $factory
398			* @param bool $profiling
399			*
400			* @return string service id
401			*/
402			private function registerAutoDiscoverableClient(ContainerBuilder $container, $name, $factory, $profiling)
403			{
404			$serviceId = 'httplug.auto_discovery.'.$name;
405
406			$pluginClientOptions = [];
407
408			if ($profiling) {
409			// Tell the plugin journal what plugins we used
410			$container
411			->getDefinition('httplug.collector.plugin_journal')
412			->addMethodCall('setPlugins', [$name, ['httplug.plugin.stopwatch']])
413			;
414
415			$debugPluginServiceId = $this->registerDebugPlugin($container, $serviceId);
416
417			$pluginClientOptions['debug_plugins'] = [new Reference($debugPluginServiceId)];
418			}
419
420			$container
421			->register($serviceId, DummyClient::class)
422			->setFactory([PluginClientFactory::class, 'createPluginClient'])
423			->setArguments([[new Reference('httplug.plugin.stopwatch')], $factory, [], $pluginClientOptions])
424			;
425
426			return $serviceId;
427			}
428
429			/**
430			* Create a new plugin service for this client.
431			*
432			* @param ContainerBuilder $container
433			* @param string $serviceId
434			*
435			* @return string
436			*/
437			private function registerDebugPlugin(ContainerBuilder $container, $serviceId)
438			{
439			$serviceIdDebugPlugin = $serviceId.'.debug_plugin';
440
441			$container
442			->register($serviceIdDebugPlugin, DebugPlugin::class)
443			->addArgument(new Reference('httplug.collector.debug_collector'))
444			->addArgument(substr($serviceId, strrpos($serviceId, '.') + 1))
445			->setPublic(false)
446			;
447
448			return $serviceIdDebugPlugin;
449			}
450
451			/**
452			* {@inheritdoc}
453			*/
454			public function getConfiguration(array $config, ContainerBuilder $container)
455			{
456			return new Configuration($container->getParameter('kernel.debug'));
457			}
458			}
459

php-http / HttplugBundle

Pull Request — master (#112)

HttplugExtension::configureSharedPlugins() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like