Configuration::getConfigTreeBuilder() - Code Metrics - Victoire/victoire - Measure and Improve Code Quality continuously with Scrutinizer

Configuration::getConfigTreeBuilder() A
last analyzed 2017-05-22 12:29 UTC

↳ Parent: Configuration

Complexity

Conditions	1
Paths	1

Size

Total Lines	21
Code Lines	17

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	21
rs	9.3142
c	0
b	0
f	0
cc	1
eloc	17
nc	1
nop	0

<?php

namespace Victoire\Bundle\SeoBundle\DependencyInjection;

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

/**
 * @author Paul Andrieux
 */
class Configuration implements ConfigurationInterface
{
    /**
     * Get the config tree builder.
     *
     * @return TreeBuilder The tree builder
     */
    public function getConfigTreeBuilder()
    {
        $treeBuilder = new TreeBuilder();
        $rootNode = $treeBuilder->root('victoire_seo');

        $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.
    }
}
            ->addDefaultsIfNotSet()
            ->children()
                ->arrayNode('analytics')
                    ->useAttributeAsKey(true)
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                    ->prototype('array')
                    ->children()
                        ->booleanNode('enabled')->defaultValue('false')->end()
                        ->scalarNode('key')->defaultNull()->end()
                    ->end()
                ->end()
                ->end()
            ->end();

        return $treeBuilder;
    }
}


1			<?php
2
3			namespace Victoire\Bundle\SeoBundle\DependencyInjection;
4
5			use Symfony\Component\Config\Definition\Builder\TreeBuilder;
6			use Symfony\Component\Config\Definition\ConfigurationInterface;
7
8			/**
9			* @author Paul Andrieux
10			*/
11			class Configuration implements ConfigurationInterface
12			{
13			/**
14			* Get the config tree builder.
15			*
16			* @return TreeBuilder The tree builder
17			*/
18			public function getConfigTreeBuilder()
19			{
20			$treeBuilder = new TreeBuilder();
21			$rootNode = $treeBuilder->root('victoire_seo');
22
23			$rootNode
			0 ignored issues – show Bug introduced 2017-03-08 09:49 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...
24			->addDefaultsIfNotSet()
25			->children()
26			->arrayNode('analytics')
27			->useAttributeAsKey(true)
			0 ignored issues – show Documentation introduced 2017-03-08 09:49 UTC by Report Bug Copy Issue Report `true` is of type `boolean`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
28			->prototype('array')
29			->children()
30			->booleanNode('enabled')->defaultValue('false')->end()
31			->scalarNode('key')->defaultNull()->end()
32			->end()
33			->end()
34			->end()
35			->end();
36
37			return $treeBuilder;
38			}
39			}
40

Victoire / victoire

Configuration::getConfigTreeBuilder() A last analyzed 2017-05-22 12:29 UTC

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

Configuration::getConfigTreeBuilder() A
last analyzed 2017-05-22 12:29 UTC