Failed Conditions
Push — ng ( e90992...13fb6e )
by Florent
17:32
created

ScopeSource::continueLoading()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 6
Code Lines 4

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 6
rs 9.4285
c 0
b 0
f 0
cc 1
eloc 4
nc 1
nop 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\Scope;
15
16
use Fluent\PhpConfigFileLoader;
17
use OAuth2Framework\Bundle\DependencyInjection\Component\Component;
18
use OAuth2Framework\Component\Model\Scope\ScopeRepositoryInterface;
19
use Symfony\Component\Config\FileLocator;
20
use Symfony\Component\Config\Definition\Builder\NodeDefinition;
21
use Symfony\Component\DependencyInjection\ContainerBuilder;
22
23
final class ScopeSource implements Component
0 ignored issues
show
Bug introduced by
There is one abstract method load in this class; you could implement it, or declare this class as abstract.
Loading history...
24
{
25
    /**
26
     * UserinfoSource constructor.
27
     */
28
    public function __construct()
29
    {
30
        $this->addSubSource(new ScopePolicySource());
0 ignored issues
show
Bug introduced by
The method addSubSource() does not seem to exist on object<OAuth2Framework\B...nent\Scope\ScopeSource>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
31
    }
32
33
    /**
34
     * {@inheritdoc}
35
     */
36
    public function name(): string
37
    {
38
        return 'scope';
39
    }
40
41
    /**
42
     * {@inheritdoc}
43
     */
44
    protected function continueLoading(string $path, ContainerBuilder $container, array $config)
0 ignored issues
show
Unused Code introduced by
The parameter $path is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
45
    {
46
        $container->setAlias(ScopeRepositoryInterface::class, $config['repository']);
47
        $loader = new PhpConfigFileLoader($container, new FileLocator(__DIR__.'/../../../Resources/config/scope'));
48
        $loader->load('scope.php');
49
    }
50
51
    /**
52
     * {@inheritdoc}
53
     */
54
    public function getNodeDefinition(NodeDefinition $node)
55
    {
56
57
        $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...
58
            ->validate()
59
                ->ifTrue(function ($config) {
60
                    return true === $config['enabled'] && empty($config['repository']);
61
                })
62
                ->thenInvalid('The option "repository" must be set.')
63
            ->end()
64
            ->children()
65
                ->scalarNode('repository')
66
                    ->info('Scope repository.')
67
                    ->defaultNull()
68
                ->end()
69
            ->end();
70
    }
71
72
    /**
73
     * {@inheritdoc}
74
     */
75
    public function prepend(ContainerBuilder $container, array $config): array
76
    {
77
        //Nothing to do
78
        return [];
79
    }
80
}
81