ClientRegistrationSource::prepend() - Code Metrics - Inspection of "Merge branch 'ng' of https://github.com/OAuth2-Fra..." - OAuth2-Framework/oauth2-framework - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — ng ( ca946d...fcb055 )

by Florent

created 2018-02-06 20:26 UTC

ClientRegistrationSource::prepend() A

↳ Parent: ClientRegistrationSource

Complexity

Conditions	2
Paths	2

Size

Total Lines	12
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	12
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	7
nc	2
nop	2

<?php

declare(strict_types=1);

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2014-2018 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\DependencyInjection\Component\Endpoint\ClientRegistration;

use OAuth2Framework\Bundle\DependencyInjection\Component\Component;
use Symfony\Component\Config\Definition\Builder\NodeDefinition;
use Symfony\Component\Config\FileLocator;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Loader\PhpFileLoader;

class ClientRegistrationSource implements Component
{
    /**
     * @var Component[]
     */
    private $subComponents = [];

    /**
     * EndpointSource constructor.
     */
    public function __construct()
    {
        $this->subComponents = [
            new InitialAccessTokenSource(),
            new SoftwareStatementSource(),
        ];
    }

    /**
     * @return string
     */
    public function name(): string
    {
        return 'client_registration';
    }

    /**
     * {@inheritdoc}
     */
    public function load(array $configs, ContainerBuilder $container)
    {
        if (!$configs['endpoint']['client_registration']['enabled']) {
            return;
        }
        $container->setParameter('oauth2_server.endpoint.client_registration.path', $configs['endpoint']['client_registration']['path']);

        $loader = new PhpFileLoader($container, new FileLocator(__DIR__ . '/../../../../Resources/config/endpoint/client_registration'));
        $loader->load('client_registration.php');

        foreach ($this->subComponents as $subComponent) {
            $subComponent->load($configs, $container);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function getNodeDefinition(NodeDefinition $node)
    {
        $childNode = $node->children()
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.
    }
}
            ->arrayNode($this->name())
                ->addDefaultsIfNotSet()
                ->canBeEnabled();

        $childNode->children()
            ->scalarNode('path')
                ->defaultValue('/client/management')
            ->end()
        ->end();

        foreach ($this->subComponents as $subComponent) {
            $subComponent->getNodeDefinition($childNode);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function prepend(ContainerBuilder $container, array $config): array
    {
        $updatedConfig = [];
        foreach ($this->subComponents as $subComponent) {
            $updatedConfig = array_merge(
                $updatedConfig,
                $subComponent->prepend($container, $config)
            );
        }

        return $updatedConfig;
    }
}


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 2018-02-06 20:36 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...
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

OAuth2-Framework / oauth2-framework

Push — ng ( ca946d...fcb055 )

ClientRegistrationSource::prepend() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like