SelfResolver - Code Metrics - Inspection of "Self resolving definitions (#356)" - PHP-DI/PHP-DI - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a051a7...500db5 )

by Matthieu

created 2016-05-15 08:59 UTC

SelfResolver A

↳ Parent: Project

Coupling/Cohesion

Components	0
Dependencies	0

Complexity

Total Complexity

Size/Duplication

Total Lines	32
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
wmc	3
c	1
b	0
f	0
lcom	0
cbo	0
dl	0
loc	32
rs	10

3 Methods

Rating	Name	Size	Complexity
A	__construct()	4	1
A	resolve()	4	1
A	isResolvable()	4	1

<?php

namespace DI\Definition\Resolver;

use DI\Definition\Definition;
use DI\Definition\SelfResolvingDefinition;
use Interop\Container\ContainerInterface;

/**
 * Resolves self-resolving definitions.
 *
 * @since 5.3
 * @author Matthieu Napoli <[email protected]>
 */
class SelfResolver implements DefinitionResolver
{
    /**
     * @var ContainerInterface
     */
    private $container;

    public function __construct(ContainerInterface $container)
    {
        $this->container = $container;
    }

    /**
     * @param SelfResolvingDefinition $definition
     *
     * {@inheritdoc}
     */
    public function resolve(Definition $definition, array $parameters = [])
    {
        return $definition->resolve($this->container);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements 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.
    }
}
    }

    /**
     * @param SelfResolvingDefinition $definition
     *
     * {@inheritdoc}
     */
    public function isResolvable(Definition $definition, array $parameters = [])
    {
        return $definition->isResolvable($this->container);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements 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.
    }
}
    }
}


Push — master ( a051a7...500db5 )

SelfResolver A

Coupling/Cohesion

Complexity

Size/Duplication

Importance

3 Methods

Available Fixes

Available Fixes

1			<?php
2
3			namespace DI\Definition\Resolver;
4
5			use DI\Definition\Definition;
6			use DI\Definition\SelfResolvingDefinition;
7			use Interop\Container\ContainerInterface;
8
9			/**
10			* Resolves self-resolving definitions.
11			*
12			* @since 5.3
13			* @author Matthieu Napoli <[email protected]>
14			*/
15			class SelfResolver implements DefinitionResolver
16			{
17			/**
18			* @var ContainerInterface
19			*/
20			private $container;
21
22			public function __construct(ContainerInterface $container)
23			{
24			$this->container = $container;
25			}
26
27			/**
28			* @param SelfResolvingDefinition $definition
29			*
30			* {@inheritdoc}
31			*/
32			public function resolve(Definition $definition, array $parameters = [])
33			{
34			return $definition->resolve($this->container);
			0 ignored issues – show Bug introduced 2015-12-27 11:49 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `DI\Definition\Definition` as the method `resolve()` does only exist in the following implementations of said interface: `DI\Definition\AliasDefinition`, `DI\Definition\StringDefinition`, `DI\Definition\ValueDefinition`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements 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 implementation 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 interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
35			}
36
37			/**
38			* @param SelfResolvingDefinition $definition
39			*
40			* {@inheritdoc}
41			*/
42			public function isResolvable(Definition $definition, array $parameters = [])
43			{
44			return $definition->isResolvable($this->container);
			0 ignored issues – show Bug introduced 2015-12-27 11:49 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `DI\Definition\Definition` as the method `isResolvable()` does only exist in the following implementations of said interface: `DI\Definition\AliasDefinition`, `DI\Definition\StringDefinition`, `DI\Definition\ValueDefinition`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements 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 implementation 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 interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
45			}
46			}
47

PHP-DI / PHP-DI

Push — master ( a051a7...500db5 )

SelfResolver A

Coupling/Cohesion

Complexity

Size/Duplication

Importance

3 Methods

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like