Failed Conditions
Pull Request — master (#22)
by Florent
08:54
created

ScopePolicySource::prepend()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 6
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 6
rs 9.4285
c 0
b 0
f 0
cc 2
eloc 3
nc 2
nop 3
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\Scope;
15
16
use Fluent\PhpConfigFileLoader;
17
use OAuth2Framework\Bundle\Server\DependencyInjection\Source\ActionableSource;
18
use OAuth2Framework\Bundle\Server\DependencyInjection\Source\SourceInterface;
19
use Symfony\Component\Config\FileLocator;
20
use Symfony\Component\Config\Definition\Builder\NodeDefinition;
21
use Symfony\Component\DependencyInjection\ContainerBuilder;
22
23
final class ScopePolicySource extends ActionableSource
24
{
25
    /**
26
     * @var SourceInterface[]
27
     */
28
    private $subSources = [];
29
30
    /**
31
     * UserinfoSource constructor.
32
     */
33
    public function __construct()
34
    {
35
        $this->subSources = [
36
            new ScopePolicyError(),
37
            new ScopePolicyDefault(),
38
        ];
39
    }
40
41
    /**
42
     * {@inheritdoc}
43
     */
44
    protected function name(): string
45
    {
46
        return 'policy';
47
    }
48
49
    /**
50
     * {@inheritdoc}
51
     */
52
    public function prepend(array $bundleConfig, string $path, ContainerBuilder $container)
53
    {
54
        foreach ($this->subSources as $source) {
55
            $source->prepend($bundleConfig, $path.'['.$this->name().']', $container);
56
        }
57
    }
58
59
    /**
60
     * {@inheritdoc}
61
     */
62
    protected function continueLoading(string $path, ContainerBuilder $container, array $config)
63
    {
64
        foreach ($this->subSources as $source) {
65
            $source->load($path, $container, $config);
66
        }
67
        foreach (['by_default'] as $k) {
68
            $container->setParameter($path.'.'.$k, $config[$k]);
69
        }
70
        $loader = new PhpConfigFileLoader($container, new FileLocator(__DIR__.'/../../../Resources/config/scope'));
71
        $loader->load('policy.php');
72
    }
73
74
    /**
75
     * {@inheritdoc}
76
     */
77
    protected function continueConfiguration(NodeDefinition $node)
78
    {
79
        parent::continueConfiguration($node);
80
        $node
0 ignored issues
show
Bug introduced by
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

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. 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.
  1. Add the method to the parent class:

    abstract class User
    {
        /** @return string */
        abstract public function getPassword();
    
        /** @return string */
        abstract public function getDisplayName();
    }
    
Loading history...
81
            ->validate()
82
                ->ifTrue(function ($config) {
83
                    return true === $config['enabled'] && empty($config['by_default']);
84
                })
85
                ->thenInvalid('The option "repository" must be set.')
86
            ->end()
87
            ->children()
88
                ->scalarNode('by_default')
89
                    ->info('Default scope policy.')
90
                    ->defaultValue('none')
91
                ->end()
92
            ->end();
93
        foreach ($this->subSources as $source) {
94
            $source->addConfiguration($node);
95
        }
96
    }
97
}
98