ArraySource::addSubSource() - Code Metrics - Inspection of "Missing Configuration Options and Better sub-Sourc..." - OAuth2-Framework/oauth2-framework - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — master ( a4b7bc...6567cc )

by Florent

created 2017-04-21 09:09 UTC

ArraySource::addSubSource() A

↳ Parent: ArraySource

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	1

<?php

declare(strict_types=1);

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2014-2017 Spomky-Labs
 *
 * This software may be modified and distributed under the terms
 * of the MIT license.  See the LICENSE file for details.
 */

namespace OAuth2Framework\Bundle\Server\DependencyInjection\Source;

use Symfony\Component\Config\Definition\Builder\NodeDefinition;
use Symfony\Component\DependencyInjection\ContainerBuilder;

abstract class ArraySource implements SourceInterface
{
    /**
     * @var SourceInterface[]
     */
    private $subSources = [];

    /**
     * @param string           $path
     * @param ContainerBuilder $container
     * @param array            $config
     */
    public function load(string $path, ContainerBuilder $container, array $config)
    {
        foreach ($this->subSources as $subSource) {
            $subSource->load($path.'.'.$this->name(), $container, $config[$this->name()]);
        }
        $this->continueLoading($path.'.'.$this->name(), $container, $config[$this->name()]);
    }

    /**
     * {@inheritdoc}
     */
    public function prepend(array $bundleConfig, string $path, ContainerBuilder $container)
    {
        foreach ($this->subSources as $subSource) {
            $subSource->prepend($bundleConfig, $path.'['.$this->name().']', $container);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function addConfiguration(NodeDefinition $node)
    {
        $sourceNode = $node
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()
                ->arrayNode($this->name())
                    ->addDefaultsIfNotSet();
        $this->continueConfiguration($sourceNode);
        foreach ($this->subSources as $subSource) {
            $subSource->addConfiguration($sourceNode);
        }
    }

    /**
     * @param string           $path
     * @param ContainerBuilder $container
     * @param array            $config
     */
    protected function continueLoading(string $path, ContainerBuilder $container, array $config)
    {
    }

    /**
     * @return string
     */
    abstract protected function name(): string;

    /**
     * @param NodeDefinition $node
     */
    protected function continueConfiguration(NodeDefinition $node)
    {
        $node->addDefaultsIfNotSet();
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.
    }
}
    }

    /**
     * @param SourceInterface $source
     */
    protected function addSubSource(SourceInterface $source)
    {
        $this->subSources[] = $source;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* The MIT License (MIT)
7			*
8			* Copyright (c) 2014-2017 Spomky-Labs
9			*
10			* This software may be modified and distributed under the terms
11			* of the MIT license. See the LICENSE file for details.
12			*/
13
14			namespace OAuth2Framework\Bundle\Server\DependencyInjection\Source;
15
16			use Symfony\Component\Config\Definition\Builder\NodeDefinition;
17			use Symfony\Component\DependencyInjection\ContainerBuilder;
18
19			abstract class ArraySource implements SourceInterface
20			{
21			/**
22			* @var SourceInterface[]
23			*/
24			private $subSources = [];
25
26			/**
27			* @param string $path
28			* @param ContainerBuilder $container
29			* @param array $config
30			*/
31			public function load(string $path, ContainerBuilder $container, array $config)
32			{
33			foreach ($this->subSources as $subSource) {
34			$subSource->load($path.'.'.$this->name(), $container, $config[$this->name()]);
35			}
36			$this->continueLoading($path.'.'.$this->name(), $container, $config[$this->name()]);
37			}
38
39			/**
40			* {@inheritdoc}
41			*/
42			public function prepend(array $bundleConfig, string $path, ContainerBuilder $container)
43			{
44			foreach ($this->subSources as $subSource) {
45			$subSource->prepend($bundleConfig, $path.'['.$this->name().']', $container);
46			}
47			}
48
49			/**
50			* {@inheritdoc}
51			*/
52			public function addConfiguration(NodeDefinition $node)
53			{
54			$sourceNode = $node
			0 ignored issues – show Bug introduced 2017-03-31 15:24 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...
55			->children()
56			->arrayNode($this->name())
57			->addDefaultsIfNotSet();
58			$this->continueConfiguration($sourceNode);
59			foreach ($this->subSources as $subSource) {
60			$subSource->addConfiguration($sourceNode);
61			}
62			}
63
64			/**
65			* @param string $path
66			* @param ContainerBuilder $container
67			* @param array $config
68			*/
69			protected function continueLoading(string $path, ContainerBuilder $container, array $config)
70			{
71			}
72
73			/**
74			* @return string
75			*/
76			abstract protected function name(): string;
77
78			/**
79			* @param NodeDefinition $node
80			*/
81			protected function continueConfiguration(NodeDefinition $node)
82			{
83			$node->addDefaultsIfNotSet();
			0 ignored issues – show Bug introduced 2017-04-02 10:41 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 `addDefaultsIfNotSet()` 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...
84			}
85
86			/**
87			* @param SourceInterface $source
88			*/
89			protected function addSubSource(SourceInterface $source)
90			{
91			$this->subSources[] = $source;
92			}
93			}
94

OAuth2-Framework / oauth2-framework

Push — master ( a4b7bc...6567cc )

ArraySource::addSubSource() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like