Configuration::getConfigTreeBuilder() - Code Metrics - Basster/legacy-bridge-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Configuration::getConfigTreeBuilder() A
last analyzed 2019-06-21 18:46 UTC

↳ Parent: Configuration

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	19
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	25
ccs	19
cts	19
cp	1
rs	9.52
c	0
b	0
f	0
cc	2
nc	2
nop	0
crap	2

<?php

namespace Basster\LegacyBridgeBundle\DependencyInjection;

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

/**
 * This is the class that validates and merges configuration from your app/config files.
 *
 * To learn more see {@link http://symfony.com/doc/current/cookbook/bundles/configuration.html}
 */
class Configuration implements ConfigurationInterface
{
    /** {@inheritdoc} */
    public function getConfigTreeBuilder()
    {
        $treeBuilder = new TreeBuilder('basster_legacy_bridge');
        $rootNode = method_exists($treeBuilder, 'getRootNode') 
            ? $treeBuilder->getRootNode() 
            : $treeBuilder->root('basster_legacy_bridge');

        
        $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.
    }
}
          ->children()
          ->scalarNode('legacy_path')
          ->defaultValue('/path/to/my/legacy/project/files')
          ->end()
          ->scalarNode('append_script')
          ->info('optional append script (see http://php.net/manual/en/ini.core.php#ini.auto-append-file)')
          ->defaultNull()
          ->end()
          ->scalarNode('prepend_script')
          ->info('optional prepend script (see http://php.net/manual/en/ini.core.php#ini.auto-prepend-file)')
          ->defaultNull()
          ->end()
          ->end()
        ;

        return $treeBuilder;
    }
}


1		<?php
2
3		namespace Basster\LegacyBridgeBundle\DependencyInjection;
4
5		use Symfony\Component\Config\Definition\Builder\TreeBuilder;
6		use Symfony\Component\Config\Definition\ConfigurationInterface;
7
8		/**
9		* This is the class that validates and merges configuration from your app/config files.
10		*
11		* To learn more see {@link http://symfony.com/doc/current/cookbook/bundles/configuration.html}
12		*/
13		class Configuration implements ConfigurationInterface
14		{
15		/** {@inheritdoc} */
16	8	public function getConfigTreeBuilder()
17		{
18	8	$treeBuilder = new TreeBuilder('basster_legacy_bridge');
19	8	$rootNode = method_exists($treeBuilder, 'getRootNode')
20	8	? $treeBuilder->getRootNode()
21	8	: $treeBuilder->root('basster_legacy_bridge');
		0 ignored issues – show Deprecated Code introduced 2019-06-21 18:32 UTC by Report Bug Copy Issue Report The method `Symfony\Component\Config...der\TreeBuilder::root()` has been deprecated with message: since Symfony 4.3, pass the root name to the constructor instead This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
22
23		$rootNode
		0 ignored issues – show Bug introduced 2019-06-21 18:32 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	8	->children()
25	8	->scalarNode('legacy_path')
26	8	->defaultValue('/path/to/my/legacy/project/files')
27	8	->end()
28	8	->scalarNode('append_script')
29	8	->info('optional append script (see http://php.net/manual/en/ini.core.php#ini.auto-append-file)')
30	8	->defaultNull()
31	8	->end()
32	8	->scalarNode('prepend_script')
33	8	->info('optional prepend script (see http://php.net/manual/en/ini.core.php#ini.auto-prepend-file)')
34	8	->defaultNull()
35	8	->end()
36	8	->end()
37		;
38
39	8	return $treeBuilder;
40		}
41		}
42

Basster / legacy-bridge-bundle

Configuration::getConfigTreeBuilder() A last analyzed 2019-06-21 18:46 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

Configuration::getConfigTreeBuilder() A
last analyzed 2019-06-21 18:46 UTC