Failed Conditions
Push — ng ( ca946d...fcb055 )
by Florent
10:43
created

ClientRegistrationSource   A

Complexity

Total Complexity 5

Size/Duplication

Total Lines 43
Duplicated Lines 0 %

Coupling/Cohesion

Components 0
Dependencies 2

Importance

Changes 0
Metric Value
wmc 5
lcom 0
cbo 2
dl 0
loc 43
rs 10
c 0
b 0
f 0

3 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 7 1
A name() 0 4 1
A load() 0 14 3
1
<?php
2
3
declare(strict_types=1);
4
5
/*
6
 * The MIT License (MIT)
7
 *
8
 * Copyright (c) 2014-2018 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\DependencyInjection\Component\Endpoint\ClientRegistration;
15
16
use OAuth2Framework\Bundle\DependencyInjection\Component\Component;
17
use Symfony\Component\Config\Definition\Builder\NodeDefinition;
18
use Symfony\Component\Config\FileLocator;
19
use Symfony\Component\DependencyInjection\ContainerBuilder;
20
use Symfony\Component\DependencyInjection\Loader\PhpFileLoader;
21
22
class ClientRegistrationSource implements Component
23
{
24
    /**
25
     * @var Component[]
26
     */
27
    private $subComponents = [];
28
29
    /**
30
     * EndpointSource constructor.
31
     */
32
    public function __construct()
33
    {
34
        $this->subComponents = [
35
            new InitialAccessTokenSource(),
36
            new SoftwareStatementSource(),
37
        ];
38
    }
39
40
    /**
41
     * @return string
42
     */
43
    public function name(): string
44
    {
45
        return 'client_registration';
46
    }
47
48
    /**
49
     * {@inheritdoc}
50
     */
51
    public function load(array $configs, ContainerBuilder $container)
52
    {
53
        if (!$configs['endpoint']['client_registration']['enabled']) {
54
            return;
55
        }
56
        $container->setParameter('oauth2_server.endpoint.client_registration.path', $configs['endpoint']['client_registration']['path']);
57
58
        $loader = new PhpFileLoader($container, new FileLocator(__DIR__ . '/../../../../Resources/config/endpoint/client_registration'));
59
        $loader->load('client_registration.php');
60
61
        foreach ($this->subComponents as $subComponent) {
62
            $subComponent->load($configs, $container);
63
        }
64
    }
65
66
    /**
67
     * {@inheritdoc}
68
     */
69
    public function getNodeDefinition(NodeDefinition $node)
70
    {
71
        $childNode = $node->children()
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...
72
            ->arrayNode($this->name())
73
                ->addDefaultsIfNotSet()
74
                ->canBeEnabled();
75
76
        $childNode->children()
77
            ->scalarNode('path')
78
                ->defaultValue('/client/management')
79
            ->end()
80
        ->end();
81
82
        foreach ($this->subComponents as $subComponent) {
83
            $subComponent->getNodeDefinition($childNode);
84
        }
85
    }
86
87
    /**
88
     * {@inheritdoc}
89
     */
90
    public function prepend(ContainerBuilder $container, array $config): array
91
    {
92
        $updatedConfig = [];
93
        foreach ($this->subComponents as $subComponent) {
94
            $updatedConfig = array_merge(
95
                $updatedConfig,
96
                $subComponent->prepend($container, $config)
97
            );
98
        }
99
100
        return $updatedConfig;
101
    }
102
}
103