Configuration::getConfigTreeBuilder() - Code Metrics - Inspection of "Merge branch 'master' into 2.0" - superdesk/web-publisher - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 2.0 ( 359ae1...221cc7 )

by Rafał

created 2020-01-09 09:11 UTC

Configuration::getConfigTreeBuilder() A

↳ Parent: Configuration

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	19
rs	9.6333
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

declare(strict_types=1);

/*
 * This file is part of the Superdesk Publisher Geo IP Bundle.
 *
 * Copyright 2019 Sourcefabric z.ú. and contributors.
 *
 * For the full copyright and license information, please see the
 * AUTHORS and LICENSE files distributed with this source code.
 *
 * @copyright 2019 Sourcefabric z.ú
 * @license http://www.superdesk.org/license
 */

namespace SWP\Bundle\GeoIPBundle\DependencyInjection;

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

class Configuration implements ConfigurationInterface
{
    /**
     * {@inheritdoc}
     */
    public function getConfigTreeBuilder()
    {
        $treeBuilder = new TreeBuilder('swp_geo_ip');
        $treeBuilder->getRootNode()
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('database_url')
                    ->cannotBeEmpty()
                    ->defaultValue('https://geolite.maxmind.com/download/geoip/database/GeoLite2-City.mmdb.gz')
                    ->info('GeoIP2 database URL')
                ->end()
                ->scalarNode('database_path')
                    ->cannotBeEmpty()
                    ->defaultValue('%kernel.cache_dir%/GeoLite2-City.mmdb')
                    ->info('Path to the downloaded GeoIP2 database')
                ->end()
            ->end();

        return $treeBuilder;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* This file is part of the Superdesk Publisher Geo IP Bundle.
7			*
8			* Copyright 2019 Sourcefabric z.ú. and contributors.
9			*
10			* For the full copyright and license information, please see the
11			* AUTHORS and LICENSE files distributed with this source code.
12			*
13			* @copyright 2019 Sourcefabric z.ú
14			* @license http://www.superdesk.org/license
15			*/
16
17			namespace SWP\Bundle\GeoIPBundle\DependencyInjection;
18
19			use Symfony\Component\Config\Definition\Builder\TreeBuilder;
20			use Symfony\Component\Config\Definition\ConfigurationInterface;
21
22			class Configuration implements ConfigurationInterface
23			{
24			/**
25			* {@inheritdoc}
26			*/
27			public function getConfigTreeBuilder()
28			{
29			$treeBuilder = new TreeBuilder('swp_geo_ip');
30			$treeBuilder->getRootNode()
			0 ignored issues – show Bug introduced 2019-04-04 14:31 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...
31			->children()
32			->scalarNode('database_url')
33			->cannotBeEmpty()
34			->defaultValue('https://geolite.maxmind.com/download/geoip/database/GeoLite2-City.mmdb.gz')
35			->info('GeoIP2 database URL')
36			->end()
37			->scalarNode('database_path')
38			->cannotBeEmpty()
39			->defaultValue('%kernel.cache_dir%/GeoLite2-City.mmdb')
40			->info('Path to the downloaded GeoIP2 database')
41			->end()
42			->end();
43
44			return $treeBuilder;
45			}
46			}
47

superdesk / web-publisher

Push — 2.0 ( 359ae1...221cc7 )

Configuration::getConfigTreeBuilder() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like