SwaggerRequestAuthorizationFactory::getPosition() - Code Metrics - Inspection of "Cleanup" - kleijnweb/swagger-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( aa6f89...863f7f )

by John

created 2017-04-05 10:39 UTC

SwaggerRequestAuthorizationFactory::getPosition() A

↳ Parent: SwaggerRequestAuthorizationFactory

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	0

<?php declare(strict_types = 1);
/*
 * This file is part of the KleijnWeb\SwaggerBundle package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace KleijnWeb\SwaggerBundle\DependencyInjection;

use Symfony\Bundle\SecurityBundle\DependencyInjection\Security\Factory\SecurityFactoryInterface;
use Symfony\Component\Config\Definition\Builder\NodeDefinition;
use Symfony\Component\Config\FileLocator;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Loader;
use Symfony\Component\DependencyInjection\Reference;

/**
 * @author John Kleijn <[email protected]>
 */
class SwaggerRequestAuthorizationFactory implements SecurityFactoryInterface
{
    public function getPosition()
    {
        return 'remember_me';
    }

    public function getKey()
    {
        return 'swagger';
    }

    public function addConfiguration(NodeDefinition $node)
    {
        $node
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.
    }
}
            ->children()
            ->booleanNode('rbac')->defaultFalse()->end()
            ->end();
    }

    public function create(ContainerBuilder $container, $id, $config, $userProvider, $defaultEntryPoint)
    {
        $loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config'));

        $loader->load('security/request_voting.yml');

        if (isset($config['rbac']) && $config['rbac']) {
            $loader->load('security/rbac.yml');
        }

        $listenerId = 'swagger.security.listener.request_authorization';

        return ['swagger.security.provider.noop', $listenerId, null];
    }
}


1			<?php declare(strict_types = 1);
2			/*
3			* This file is part of the KleijnWeb\SwaggerBundle package.
4			*
5			* For the full copyright and license information, please view the LICENSE
6			* file that was distributed with this source code.
7			*/
8			namespace KleijnWeb\SwaggerBundle\DependencyInjection;
9
10			use Symfony\Bundle\SecurityBundle\DependencyInjection\Security\Factory\SecurityFactoryInterface;
11			use Symfony\Component\Config\Definition\Builder\NodeDefinition;
12			use Symfony\Component\Config\FileLocator;
13			use Symfony\Component\DependencyInjection\ContainerBuilder;
14			use Symfony\Component\DependencyInjection\Loader;
15			use Symfony\Component\DependencyInjection\Reference;
16
17			/**
18			* @author John Kleijn <[email protected]>
19			*/
20			class SwaggerRequestAuthorizationFactory implements SecurityFactoryInterface
21			{
22			public function getPosition()
23			{
24			return 'remember_me';
25			}
26
27			public function getKey()
28			{
29			return 'swagger';
30			}
31
32			public function addConfiguration(NodeDefinition $node)
33			{
34			$node
			0 ignored issues – show Bug introduced 2017-04-05 10:47 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...
35			->children()
36			->booleanNode('rbac')->defaultFalse()->end()
37			->end();
38			}
39
40			public function create(ContainerBuilder $container, $id, $config, $userProvider, $defaultEntryPoint)
41			{
42			$loader = new Loader\YamlFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config'));
43
44			$loader->load('security/request_voting.yml');
45
46			if (isset($config['rbac']) && $config['rbac']) {
47			$loader->load('security/rbac.yml');
48			}
49
50			$listenerId = 'swagger.security.listener.request_authorization';
51
52			return ['swagger.security.provider.noop', $listenerId, null];
53			}
54			}
55

kleijnweb / swagger-bundle

Push — master ( aa6f89...863f7f )

SwaggerRequestAuthorizationFactory::getPosition() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like