FriendlyInitializer::supports() - Code Metrics - KnpLabs/FriendlyContexts - Measure and Improve Code Quality continuously with Scrutinizer

FriendlyInitializer::supports() A
last analyzed 2017-07-04 16:51 UTC

↳ Parent: FriendlyInitializer

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace Knp\FriendlyContexts\Context\Initializer;

use Behat\Behat\Context\Initializer\ContextInitializer;
use Behat\Behat\Context\Context as ContextInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Knp\FriendlyContexts\Context\Context;

class FriendlyInitializer implements ContextInitializer
{
    protected $config;
    protected $container;

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

    public function supports($context)
    {
        return $context instanceof Context;
    }

    public function initializeContext(ContextInterface $context)
    {
        if (false === $this->supports($context)) {

            return;
        }

        $context->initialize($this->config, $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.
    }
}
    }
}


1			<?php
2
3			namespace Knp\FriendlyContexts\Context\Initializer;
4
5			use Behat\Behat\Context\Initializer\ContextInitializer;
6			use Behat\Behat\Context\Context as ContextInterface;
7			use Symfony\Component\DependencyInjection\ContainerInterface;
8			use Knp\FriendlyContexts\Context\Context;
9
10			class FriendlyInitializer implements ContextInitializer
11			{
12			protected $config;
13			protected $container;
14
15			public function __construct($config, ContainerInterface $container)
16			{
17			$this->config = $config;
18			$this->container = $container;
19			}
20
21			public function supports($context)
22			{
23			return $context instanceof Context;
24			}
25
26			public function initializeContext(ContextInterface $context)
27			{
28			if (false === $this->supports($context)) {
29
30			return;
31			}
32
33			$context->initialize($this->config, $this->container);
			0 ignored issues – show Bug introduced 2015-12-02 11:45 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Behat\Behat\Context\Context` as the method `initialize()` does only exist in the following implementations of said interface: `Knp\FriendlyContexts\Context\AliceContext`, `Knp\FriendlyContexts\Context\ApiContext`, `Knp\FriendlyContexts\Context\Context`, `Knp\FriendlyContexts\Context\EntityContext`, `Knp\FriendlyContexts\Context\PageContext`, `Knp\FriendlyContexts\Context\RawMinkContext`, `Knp\FriendlyContexts\Context\RawPageContext`, `Knp\FriendlyContexts\Context\TableContext`. 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...
34			}
35			}
36

KnpLabs / FriendlyContexts

FriendlyInitializer::supports() A last analyzed 2017-07-04 16:51 UTC

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

FriendlyInitializer::supports() A
last analyzed 2017-07-04 16:51 UTC