RouteConfig::getArray() - Code Metrics - Inspection of "navigation factory refactoring" - everlutionsk/navigation - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — master ( 3eb0e4...9196b6 )

by Ivan

created 2016-12-28 22:30 UTC

RouteConfig::getArray() A

↳ Parent: RouteConfig

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	9
rs	9.6666
c	0
b	0
f	0
cc	1
eloc	6
nc	1
nop	1

<?php

declare(strict_types = 1);

namespace Everlution\Navigation\Factory\Build\Hydrator\Item;

use Everlution\Navigation\Factory\Build\ItemConfig;
use Everlution\Navigation\Item;
use Everlution\Navigation\Item\Route;
use Everlution\Navigation\Factory\Build\Hydrator\Item as HydratorItem;

/**
 * Class RouteConfig.
 * @author Ivan Barlog <[email protected]>
 */
class RouteConfig extends HydratorItem implements ItemConfig
{
    const OPTION_ROUTE = 'route';
    const OPTION_ROUTE_PARAMS = 'params';

    /**
     * @param string $className
     * @param array $arguments
     * @return mixed
     */
    protected function getObject(string $className, array $arguments)
    {
        return new $className(
            $arguments[self::OPTION_LABEL],
            $arguments[self::OPTION_ROUTE],
            $arguments[self::OPTION_ROUTE_PARAMS]
        );
    }

    /**
     * @param Route|Item $object
     * @return array
     */
    protected function getArray($object): array
    {
        return [
            self::OPTION_CLASS => get_class($object),
            self::OPTION_LABEL => $object->getLabel(),
            self::OPTION_ROUTE => $object->getRoute(),
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.
    }
}
            self::OPTION_ROUTE_PARAMS => $object->getRouteParameters(),
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.
    }
}
        ];
    }

    protected function config()
    {
        $this->resolver->setRequired([self::OPTION_ROUTE, self::OPTION_ROUTE_PARAMS]);
        $this->resolver->setAllowedTypes(self::OPTION_ROUTE, 'string');
        $this->resolver->setAllowedTypes(self::OPTION_ROUTE_PARAMS, 'array');
        $this->resolver->setDefault(self::OPTION_ROUTE_PARAMS, []);
        $this->supportedClasses[] = Route::class;
    }
}


Push — master ( 3eb0e4...9196b6 )

RouteConfig::getArray() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

1			<?php
2
3			declare(strict_types = 1);
4
5			namespace Everlution\Navigation\Factory\Build\Hydrator\Item;
6
7			use Everlution\Navigation\Factory\Build\ItemConfig;
8			use Everlution\Navigation\Item;
9			use Everlution\Navigation\Item\Route;
10			use Everlution\Navigation\Factory\Build\Hydrator\Item as HydratorItem;
11
12			/**
13			* Class RouteConfig.
14			* @author Ivan Barlog <[email protected]>
15			*/
16			class RouteConfig extends HydratorItem implements ItemConfig
17			{
18			const OPTION_ROUTE = 'route';
19			const OPTION_ROUTE_PARAMS = 'params';
20
21			/**
22			* @param string $className
23			* @param array $arguments
24			* @return mixed
25			*/
26			protected function getObject(string $className, array $arguments)
27			{
28			return new $className(
29			$arguments[self::OPTION_LABEL],
30			$arguments[self::OPTION_ROUTE],
31			$arguments[self::OPTION_ROUTE_PARAMS]
32			);
33			}
34
35			/**
36			* @param Route\|Item $object
37			* @return array
38			*/
39			protected function getArray($object): array
40			{
41			return [
42			self::OPTION_CLASS => get_class($object),
43			self::OPTION_LABEL => $object->getLabel(),
44			self::OPTION_ROUTE => $object->getRoute(),
			0 ignored issues – show Bug introduced 2016-12-28 22:32 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Everlution\Navigation\Item` as the method `getRoute()` does only exist in the following implementations of said interface: `Everlution\Navigation\Item\Route`. 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			self::OPTION_ROUTE_PARAMS => $object->getRouteParameters(),
			0 ignored issues – show Bug introduced 2016-12-28 22:32 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Everlution\Navigation\Item` as the method `getRouteParameters()` does only exist in the following implementations of said interface: `Everlution\Navigation\Item\Route`. 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...
46			];
47			}
48
49			protected function config()
50			{
51			$this->resolver->setRequired([self::OPTION_ROUTE, self::OPTION_ROUTE_PARAMS]);
52			$this->resolver->setAllowedTypes(self::OPTION_ROUTE, 'string');
53			$this->resolver->setAllowedTypes(self::OPTION_ROUTE_PARAMS, 'array');
54			$this->resolver->setDefault(self::OPTION_ROUTE_PARAMS, []);
55			$this->supportedClasses[] = Route::class;
56			}
57			}
58

everlutionsk / navigation

Push — master ( 3eb0e4...9196b6 )

RouteConfig::getArray() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like