XabbuhPandaExtension::loadClouds() - Code Metrics - Inspection of "improve the Travis config" - xabbuh/PandaBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 009570...798a5b )

by Christian

created 2016-10-20 20:10 UTC

XabbuhPandaExtension::loadClouds() B

↳ Parent: XabbuhPandaExtension

Complexity

Conditions	4
Paths	3

Size

Total Lines	31
Code Lines	18

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	15
CRAP Score	4.026

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	31
ccs	15
cts	17
cp	0.8824
rs	8.5806
cc	4
eloc	18
nc	3
nop	2
crap	4.026

<?php

/*
 * This file is part of the XabbuhPandaBundle package.
 *
 * (c) Christian Flothmann <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Xabbuh\PandaBundle\DependencyInjection;

use Symfony\Component\Config\FileLocator;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Definition;
use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
use Symfony\Component\DependencyInjection\Reference;
use Symfony\Component\HttpKernel\DependencyInjection\Extension;

/**
 * XabbuhPandaExtension.
 *
 * @author Christian Flothmann <[email protected]>
 */
class XabbuhPandaExtension extends Extension
{
    /**
     * {@inheritDoc}
     */
    public function load(array $configs, ContainerBuilder $container)
    {
        $configuration = new Configuration();
        $config = $this->processConfiguration($configuration, $configs);

        $container->setParameter(
            'xabbuh_panda.video_uploader.multiple_files',
            $config['video_uploader']['multiple_files']
        );
        $container->setParameter(
            'xabbuh_panda.video_uploader.cancel_button',
            $config['video_uploader']['cancel_button']
        );
        $container->setParameter(
            'xabbuh_panda.video_uploader.progress_bar',
            $config['video_uploader']['progress_bar']
        );

        $container->setParameter('xabbuh_panda.account.default', $config['default_account']);
        $container->setParameter('xabbuh_panda.cloud.default', $config['default_cloud']);

        // and load the service definitions
        $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
        $loader->load('account_manager.xml');
        $loader->load('cloud_manager.xml');
        $loader->load('cloud_factory.xml');
        $loader->load('controller.xml');
        $loader->load('transformers.xml');
        $loader->load('video_uploader_extension.xml');

        // Add the tag for the form type extension without using deprecated APIs
        if (method_exists('Symfony\Component\Form\AbstractType', 'getBlockPrefix')) {
            $container->getDefinition('xabbuh_panda.video_uploader_extension')
                ->addTag('form.type_extension', array('extended_type' => 'Symfony\Component\Form\Extension\Core\Type\FileType'));
        } else {
            $container->getDefinition('xabbuh_panda.video_uploader_extension')
                ->addTag('form.type_extension', array('alias' => 'file'));
        }

        $this->loadAccounts($config['accounts'], $container);
        $this->loadClouds($config['clouds'], $container);
        $this->registerSerializerFactory($container);
    }

    private function loadAccounts(array $accounts, ContainerBuilder $container)
    {
        $accountManagerDefinition = $container->getDefinition('xabbuh_panda.account_manager');

        foreach ($accounts as $name => $accountConfig) {
            // register each account as a service
            $accountDefinition = new Definition(
                'Xabbuh\PandaClient\Api\Account',
                array(
                    $accountConfig['access_key'],
                    $accountConfig['secret_key'],
                    $accountConfig['api_host']
                )
            );
            $id = 'xabbuh_panda.'.strtr($name, ' -', '_').'_account';
            $container->setDefinition($id, $accountDefinition);

            // and pass it to the manager's registerAccount() method
            $accountManagerDefinition->addMethodCall(
                'registerAccount',
                array($name, new Reference($id))
            );
        }
    }

    private function loadClouds(array $clouds, ContainerBuilder $container)
    {
        $cloudManagerDefinition = $container->getDefinition('xabbuh_panda.cloud_manager');

        foreach ($clouds as $name => $cloudConfig) {
            // register each cloud as a service
            $cloudDefinition = new Definition(
                'Xabbuh\PandaClient\Api\Cloud',
                array(
                    $cloudConfig['id'],
                    isset($cloudConfig['account']) ? $cloudConfig['account'] : null,
                )
            );

            if (method_exists($cloudDefinition, 'setFactory')) {
                $cloudDefinition->setFactory(array(new Reference('xabbuh_panda.cloud_factory'), 'get'));
            } else {
                $cloudDefinition->setFactoryService('xabbuh_panda.cloud_factory');
                $cloudDefinition->setFactoryMethod('get');
            }

            $id = 'xabbuh_panda.'.strtr($name, ' -', '_').'_cloud';
            $container->setDefinition($id, $cloudDefinition);

            // and pass it to the manager's registerAccount() method
            $cloudManagerDefinition->addMethodCall(
                'registerCloud',
                array($name, new Reference($id))
            );
        }
    }

    private function registerSerializerFactory(ContainerBuilder $container)
    {
        $serializers = array(
            'xabbuh_panda.serializer.cloud' => 'getCloudSerializer',
            'xabbuh_panda.serializer.encoding' => 'getEncodingSerializer',
            'xabbuh_panda.serializer.profile' => 'getProfileSerializer',
            'xabbuh_panda.serializer.video' => 'getVideoSerializer',
        );

        foreach ($serializers as $serviceId => $factoryMethod) {
            $definition = $container->getDefinition($serviceId);

            if (method_exists($definition, 'setFactory')) {
                $definition->setFactory(array('%xabbuh_panda.serializer.factory.class%', $factoryMethod));
            } else {
                $definition->setFactoryClass('%xabbuh_panda.serializer.factory.class%');
                $definition->setFactoryMethod($factoryMethod);
            }
        }
    }

    /**
     * {@inheritDoc}
     */
    public function getNamespace()
    {
        return 'http://xabbuh.de/schema/dic/xabbuh/panda';
    }

    /**
     * {@inheritDoc}
     */
    public function getXsdValidationBasePath()
    {
        return __DIR__.'/../Resources/config/schema';
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }
}


1		<?php
2
3		/*
4		* This file is part of the XabbuhPandaBundle package.
5		*
6		* (c) Christian Flothmann <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace Xabbuh\PandaBundle\DependencyInjection;
13
14		use Symfony\Component\Config\FileLocator;
15		use Symfony\Component\DependencyInjection\ContainerBuilder;
16		use Symfony\Component\DependencyInjection\Definition;
17		use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
18		use Symfony\Component\DependencyInjection\Reference;
19		use Symfony\Component\HttpKernel\DependencyInjection\Extension;
20
21		/**
22		* XabbuhPandaExtension.
23		*
24		* @author Christian Flothmann <[email protected]>
25		*/
26		class XabbuhPandaExtension extends Extension
27		{
28		/**
29		* {@inheritDoc}
30		*/
31	4	public function load(array $configs, ContainerBuilder $container)
32		{
33	4	$configuration = new Configuration();
34	4	$config = $this->processConfiguration($configuration, $configs);
35
36	4	$container->setParameter(
37	4	'xabbuh_panda.video_uploader.multiple_files',
38	4	$config['video_uploader']['multiple_files']
39		);
40	4	$container->setParameter(
41	4	'xabbuh_panda.video_uploader.cancel_button',
42	4	$config['video_uploader']['cancel_button']
43		);
44	4	$container->setParameter(
45	4	'xabbuh_panda.video_uploader.progress_bar',
46	4	$config['video_uploader']['progress_bar']
47		);
48
49	4	$container->setParameter('xabbuh_panda.account.default', $config['default_account']);
50	4	$container->setParameter('xabbuh_panda.cloud.default', $config['default_cloud']);
51
52		// and load the service definitions
53	4	$loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
54	4	$loader->load('account_manager.xml');
55	4	$loader->load('cloud_manager.xml');
56	4	$loader->load('cloud_factory.xml');
57	4	$loader->load('controller.xml');
58	4	$loader->load('transformers.xml');
59	4	$loader->load('video_uploader_extension.xml');
60
61		// Add the tag for the form type extension without using deprecated APIs
62	4	if (method_exists('Symfony\Component\Form\AbstractType', 'getBlockPrefix')) {
63	4	$container->getDefinition('xabbuh_panda.video_uploader_extension')
64	4	->addTag('form.type_extension', array('extended_type' => 'Symfony\Component\Form\Extension\Core\Type\FileType'));
65		} else {
66		$container->getDefinition('xabbuh_panda.video_uploader_extension')
67		->addTag('form.type_extension', array('alias' => 'file'));
68		}
69
70	4	$this->loadAccounts($config['accounts'], $container);
71	4	$this->loadClouds($config['clouds'], $container);
72	4	$this->registerSerializerFactory($container);
73	4	}
74
75	4	private function loadAccounts(array $accounts, ContainerBuilder $container)
76		{
77	4	$accountManagerDefinition = $container->getDefinition('xabbuh_panda.account_manager');
78
79	4	foreach ($accounts as $name => $accountConfig) {
80		// register each account as a service
81	1	$accountDefinition = new Definition(
82	1	'Xabbuh\PandaClient\Api\Account',
83		array(
84	1	$accountConfig['access_key'],
85	1	$accountConfig['secret_key'],
86	1	$accountConfig['api_host']
87		)
88		);
89	1	$id = 'xabbuh_panda.'.strtr($name, ' -', '_').'_account';
90	1	$container->setDefinition($id, $accountDefinition);
91
92		// and pass it to the manager's registerAccount() method
93	1	$accountManagerDefinition->addMethodCall(
94	1	'registerAccount',
95	1	array($name, new Reference($id))
96		);
97		}
98	4	}
99
100	4	private function loadClouds(array $clouds, ContainerBuilder $container)
101		{
102	4	$cloudManagerDefinition = $container->getDefinition('xabbuh_panda.cloud_manager');
103
104	4	foreach ($clouds as $name => $cloudConfig) {
105		// register each cloud as a service
106	2	$cloudDefinition = new Definition(
107	2	'Xabbuh\PandaClient\Api\Cloud',
108		array(
109	2	$cloudConfig['id'],
110	2	isset($cloudConfig['account']) ? $cloudConfig['account'] : null,
111		)
112		);
113
114	2	if (method_exists($cloudDefinition, 'setFactory')) {
115	2	$cloudDefinition->setFactory(array(new Reference('xabbuh_panda.cloud_factory'), 'get'));
116		} else {
117		$cloudDefinition->setFactoryService('xabbuh_panda.cloud_factory');
118		$cloudDefinition->setFactoryMethod('get');
119		}
120
121	2	$id = 'xabbuh_panda.'.strtr($name, ' -', '_').'_cloud';
122	2	$container->setDefinition($id, $cloudDefinition);
123
124		// and pass it to the manager's registerAccount() method
125	2	$cloudManagerDefinition->addMethodCall(
126	2	'registerCloud',
127	2	array($name, new Reference($id))
128		);
129		}
130	4	}
131
132	4	private function registerSerializerFactory(ContainerBuilder $container)
133		{
134		$serializers = array(
135	4	'xabbuh_panda.serializer.cloud' => 'getCloudSerializer',
136		'xabbuh_panda.serializer.encoding' => 'getEncodingSerializer',
137		'xabbuh_panda.serializer.profile' => 'getProfileSerializer',
138		'xabbuh_panda.serializer.video' => 'getVideoSerializer',
139		);
140
141	4	foreach ($serializers as $serviceId => $factoryMethod) {
142	4	$definition = $container->getDefinition($serviceId);
143
144	4	if (method_exists($definition, 'setFactory')) {
145	4	$definition->setFactory(array('%xabbuh_panda.serializer.factory.class%', $factoryMethod));
146		} else {
147		$definition->setFactoryClass('%xabbuh_panda.serializer.factory.class%');
148	4	$definition->setFactoryMethod($factoryMethod);
149		}
150		}
151	4	}
152
153		/**
154		* {@inheritDoc}
155		*/
156	4	public function getNamespace()
157		{
158	4	return 'http://xabbuh.de/schema/dic/xabbuh/panda';
159		}
160
161		/**
162		* {@inheritDoc}
163		*/
164		public function getXsdValidationBasePath()
165		{
166		return __DIR__.'/../Resources/config/schema';
		0 ignored issues – show Bug Best Practice introduced 2015-11-26 22:49 UTC by Report Bug Copy Issue Report The return type of `return __DIR__ . '/../Resources/config/schema';` (`string`) is incompatible with the return type of the parent method `Symfony\Component\Depend...etXsdValidationBasePath` of type `boolean`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
167		}
168		}
169

xabbuh / PandaBundle

Push — master ( 009570...798a5b )

XabbuhPandaExtension::loadClouds() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like