Configuration::getConfigTreeBuilder() - Code Metrics - mauro-moreno/find-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Configuration::getConfigTreeBuilder() A
last analyzed 2016-02-04 01:38 UTC

↳ Parent: Configuration

Complexity

Conditions	1
Paths	1

Size

Total Lines	20
Code Lines	17

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	16
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	20
ccs	16
cts	16
cp	1
rs	9.4285
cc	1
eloc	17
nc	1
nop	0
crap	1

<?php
/**
 * Class Configuration
 * @author Mauro Moreno <[email protected]>
 */
namespace MauroMoreno\FindBundle\DependencyInjection;

use Symfony\Component\Config\Definition\Builder\TreeBuilder;
use Symfony\Component\Config\Definition\ConfigurationInterface;

/**
 * Class Configuration
 * @package MauroMoreno\FindBundle\DependencyInjection
 */
class Configuration implements ConfigurationInterface
{

    /**
     * Get config tree builder
     * @return TreeBuilder
     */
    public function getConfigTreeBuilder()
    {
        $treeBuilder = new TreeBuilder();
        $rootNode = $treeBuilder->root('mauro_moreno_find');
        $rootNode
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            ->isRequired()
            ->children()
                ->scalarNode('find_directory_service')
                    ->isRequired()
                ->end()
                ->scalarNode('finder')
                    ->isRequired()
                ->end()
                ->scalarNode('lister')
                    ->isRequired()
                ->end()
            ->end();

        return $treeBuilder;
    }

}


1		<?php
2		/**
3		* Class Configuration
4		* @author Mauro Moreno <[email protected]>
5		*/
6		namespace MauroMoreno\FindBundle\DependencyInjection;
7
8		use Symfony\Component\Config\Definition\Builder\TreeBuilder;
9		use Symfony\Component\Config\Definition\ConfigurationInterface;
10
11		/**
12		* Class Configuration
13		* @package MauroMoreno\FindBundle\DependencyInjection
14		*/
15		class Configuration implements ConfigurationInterface
16		{
17
18		/**
19		* Get config tree builder
20		* @return TreeBuilder
21		*/
22	8	public function getConfigTreeBuilder()
23		{
24	8	$treeBuilder = new TreeBuilder();
25	8	$rootNode = $treeBuilder->root('mauro_moreno_find');
26		$rootNode
		0 ignored issues – show Bug introduced 2016-02-04 01:26 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Symfony\Component\Config...\Builder\NodeDefinition` as the method `children()` does only exist in the following sub-classes of `Symfony\Component\Config...\Builder\NodeDefinition`: `Symfony\Component\Config...der\ArrayNodeDefinition`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
27	8	->isRequired()
28	8	->children()
29	8	->scalarNode('find_directory_service')
30	8	->isRequired()
31	8	->end()
32	8	->scalarNode('finder')
33	8	->isRequired()
34	8	->end()
35	8	->scalarNode('lister')
36	8	->isRequired()
37	8	->end()
38	8	->end();
39
40	8	return $treeBuilder;
41		}
42
43		}
44

mauro-moreno / find-bundle

Configuration::getConfigTreeBuilder() A last analyzed 2016-02-04 01:38 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

Configuration::getConfigTreeBuilder() A
last analyzed 2016-02-04 01:38 UTC