ClientConfigurationSource::getNodeDefinition() - 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

ClientConfigurationSource::getNodeDefinition() B

↳ Parent: ClientConfigurationSource

Complexity

Conditions	2
Paths	1

Size

Total Lines	31
Code Lines	28

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	31
rs	8.8571
c	0
b	0
f	0
cc	2
eloc	28
nc	1
nop	1

<?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\ClientConfiguration;

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 ClientConfigurationSource implements Component
{
    /**
     * @return string
     */
    public function name(): string
    {
        return 'client_configuration';
    }

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

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

    /**
     * {@inheritdoc}
     */
    public function getNodeDefinition(NodeDefinition $node)
    {
        $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())
                ->validate()
                    ->ifTrue(function ($config) {
                        return true === $config['enabled'] && empty($config['realm']);
                    })
                    ->thenInvalid('The option "realm" must be set.')
                ->end()
                ->addDefaultsIfNotSet()
                ->canBeEnabled()
                ->children()
                    ->scalarNode('realm')
                        ->end()
                    ->booleanNode('authorization_header')
                        ->defaultTrue()
                    ->end()
                    ->booleanNode('query_string')
                        ->defaultFalse()
                    ->end()
                    ->booleanNode('request_body')
                        ->defaultFalse()
                    ->end()
                    ->scalarNode('path')
                        ->defaultValue('/client/configure/{client_id}')
                    ->end()
                ->end()
            ->end()
        ->end();
    }

    /**
     * {@inheritdoc}
     */
    public function prepend(ContainerBuilder $container, array $config): array
    {
        return [];
    }
}


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\ClientConfiguration;
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 ClientConfigurationSource implements Component
23			{
24			/**
25			* @return string
26			*/
27			public function name(): string
28			{
29			return 'client_configuration';
30			}
31
32			/**
33			* {@inheritdoc}
34			*/
35			public function load(array $configs, ContainerBuilder $container)
36			{
37			if (!$configs['endpoint']['client_configuration']['enabled']) {
38			return;
39			}
40			$container->setParameter('oauth2_server.endpoint.client_configuration.path', $configs['endpoint']['client_configuration']['path']);
41			$container->setParameter('oauth2_server.endpoint.client_configuration.realm', $configs['endpoint']['client_configuration']['realm']);
42			$container->setParameter('oauth2_server.endpoint.client_configuration.authorization_header', $configs['endpoint']['client_configuration']['authorization_header']);
43			$container->setParameter('oauth2_server.endpoint.client_configuration.query_string', $configs['endpoint']['client_configuration']['query_string']);
44			$container->setParameter('oauth2_server.endpoint.client_configuration.request_body', $configs['endpoint']['client_configuration']['request_body']);
45
46			$loader = new PhpFileLoader($container, new FileLocator(__DIR__ . '/../../../../Resources/config/endpoint/client_configuration'));
47			$loader->load('client_configuration.php');
48			}
49
50			/**
51			* {@inheritdoc}
52			*/
53			public function getNodeDefinition(NodeDefinition $node)
54			{
55			$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...
56			->arrayNode($this->name())
57			->validate()
58			->ifTrue(function ($config) {
59			return true === $config['enabled'] && empty($config['realm']);
60			})
61			->thenInvalid('The option "realm" must be set.')
62			->end()
63			->addDefaultsIfNotSet()
64			->canBeEnabled()
65			->children()
66			->scalarNode('realm')
67			->end()
68			->booleanNode('authorization_header')
69			->defaultTrue()
70			->end()
71			->booleanNode('query_string')
72			->defaultFalse()
73			->end()
74			->booleanNode('request_body')
75			->defaultFalse()
76			->end()
77			->scalarNode('path')
78			->defaultValue('/client/configure/{client_id}')
79			->end()
80			->end()
81			->end()
82			->end();
83			}
84
85			/**
86			* {@inheritdoc}
87			*/
88			public function prepend(ContainerBuilder $container, array $config): array
89			{
90			return [];
91			}
92			}
93

OAuth2-Framework / oauth2-framework

Push — ng ( ca946d...fcb055 )

ClientConfigurationSource::getNodeDefinition() B

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like