AbstractSource::create() - Code Metrics - Inspection of "WIP JoseFrameworkBundle" - Spomky-Labs/jose - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — v7 ( 477009...5356df )

by Florent

created 2017-09-04 22:40 UTC

AbstractSource::create() A

↳ Parent: AbstractSource

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	7
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	5
nc	1
nop	4

<?php

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2014-2016 Spomky-Labs
 *
 * This software may be modified and distributed under the terms
 * of the MIT license.  See the LICENSE file for details.
 */

namespace Jose\Bundle\JoseFramework\DependencyInjection\Source;

use Symfony\Component\Config\Definition\Builder\NodeDefinition;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Definition;

abstract class AbstractSource
{
    /**
     * @param ContainerBuilder $container
     * @param array            $config
     *
     * @return Definition
     */
    abstract protected function createDefinition(ContainerBuilder $container, array $config): Definition;

    /**
     * {@inheritdoc}
     */
    public function create(ContainerBuilder $container, string $type, string $name, array $config)
    {
        $service_id = sprintf('jose.%s.%s', $type, $name);
        $definition = $this->createDefinition($container, $config);
        $definition->setPublic($config['is_public']);
        $container->setDefinition($service_id, $definition);
    }

    /**
     * @param NodeDefinition $node
     */
    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('is_public')
                    ->info('If true, the service will be public, else private.')
                    ->defaultTrue()
                ->end()
            ->end();
    }
}


1			<?php
2
3			/*
4			* The MIT License (MIT)
5			*
6			* Copyright (c) 2014-2016 Spomky-Labs
7			*
8			* This software may be modified and distributed under the terms
9			* of the MIT license. See the LICENSE file for details.
10			*/
11
12			namespace Jose\Bundle\JoseFramework\DependencyInjection\Source;
13
14			use Symfony\Component\Config\Definition\Builder\NodeDefinition;
15			use Symfony\Component\DependencyInjection\ContainerBuilder;
16			use Symfony\Component\DependencyInjection\Definition;
17
18			abstract class AbstractSource
19			{
20			/**
21			* @param ContainerBuilder $container
22			* @param array $config
23			*
24			* @return Definition
25			*/
26			abstract protected function createDefinition(ContainerBuilder $container, array $config): Definition;
27
28			/**
29			* {@inheritdoc}
30			*/
31			public function create(ContainerBuilder $container, string $type, string $name, array $config)
32			{
33			$service_id = sprintf('jose.%s.%s', $type, $name);
34			$definition = $this->createDefinition($container, $config);
35			$definition->setPublic($config['is_public']);
36			$container->setDefinition($service_id, $definition);
37			}
38
39			/**
40			* @param NodeDefinition $node
41			*/
42			public function addConfiguration(NodeDefinition $node)
43			{
44			$node
			1 ignored issue – show Bug introduced 2017-09-04 22:43 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...
45			->children()
46			->booleanNode('is_public')
47			->info('If true, the service will be public, else private.')
48			->defaultTrue()
49			->end()
50			->end();
51			}
52			}
53

Spomky-Labs / jose

Push — v7 ( 477009...5356df )

AbstractSource::create() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like