MiddlewareAwareTrait::lazyMiddlewares() - Code Metrics - Inspection of "Lazy middleware loading" - thephpleague/route - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#218)

by Phil

created 2018-10-16 14:21 UTC

MiddlewareAwareTrait::lazyMiddlewares() A

↳ Parent: MiddlewareAwareTrait

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
dl	0
loc	8
ccs	0
cts	4
cp	0
rs	10
c	0
b	0
f	0
cc	2
nc	2
nop	1
crap	6

<?php declare(strict_types=1);

namespace League\Route\Middleware;

use InvalidArgumentException;
use Psr\Container\ContainerInterface;
use Psr\Http\Server\MiddlewareInterface;

trait MiddlewareAwareTrait
{
    /**
     * @var array
     */
    protected $middleware = [];

    /**
     * {@inheritdoc}
     */
    public function middleware(MiddlewareInterface $middleware) : MiddlewareAwareInterface
    {
        $this->middleware[] = $middleware;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function middlewares(array $middlewares) : MiddlewareAwareInterface
    {
        foreach ($middlewares as $middleware) {
            $this->middleware($middleware);
        }

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function prependMiddleware(MiddlewareInterface $middleware) : MiddlewareAwareInterface
    {
        array_unshift($this->middleware, $middleware);

        return $this;
    }

    /**
     * Add a middleware as a class name to the stack
     *
     * @param string $middleware
     *
     * @return static
     */
    public function lazyMiddleware(string $middleware) : MiddlewareAwareInterface
    {
        $this->middleware[] = $middleware;

        return $this;
    }

    /**
     * Add multiple middlewares as class names to the stack
     *
     * @param string[] $middlewares
     *
     * @return static
     */
    public function lazyMiddlewares(array $middlewares) : MiddlewareAwareInterface
    {
        foreach ($middlewares as $middleware) {
            $this->lazyMiddleware($middleware);
        }

        return $this;
    }

    /**
     * Prepend a middleware as a class name to the stack
     *
     * @param string $middleware
     *
     * @return static
     */
    public function lazyPrependMiddleware(string $middleware) : MiddlewareAwareInterface
    {
        array_unshift($this->middleware, $middleware);

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function shiftMiddleware() : MiddlewareInterface
    {
        return array_shift($this->middleware);
    }

    /**
     * {@inheritdoc}
     */
    public function getMiddlewareStack() : iterable
    {
        return $this->middleware;
    }

    /**
     * Resolve a middleware implementation, optionally from a container
     *
     * @param \Psr\Http\Server\MiddlewareInterface|string $middleware
     * @param \Psr\Container\ContainerInterface|null      $container
     *
     * @return \Psr\Http\Server\MiddlewareInterface
     */
    protected function resolveMiddleware($middleware, ?ContainerInterface $container = null) : MiddlewareInterface
    {
        if (is_null($container) && is_string($middleware) && class_exists($middleware)) {
            $middleware = new $middleware;
        }

        if (! is_null($container) && is_string($middleware) && $container->has($middleware)) {
            $middleware = $container->get($middleware);
        }

        if ($middleware instanceof MiddlewareInterface) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
            return $middleware;
        }

        throw new InvalidArgumentException(sprintf('Could not resolve middleware class: %s', $middleware));
    }
}


1		<?php declare(strict_types=1);
2
3		namespace League\Route\Middleware;
4
5		use InvalidArgumentException;
6		use Psr\Container\ContainerInterface;
7		use Psr\Http\Server\MiddlewareInterface;
8
9		trait MiddlewareAwareTrait
10		{
11		/**
12		* @var array
13		*/
14		protected $middleware = [];
15
16		/**
17		* {@inheritdoc}
18		*/
19	16	public function middleware(MiddlewareInterface $middleware) : MiddlewareAwareInterface
20		{
21	16	$this->middleware[] = $middleware;
22
23	16	return $this;
24		}
25
26		/**
27		* {@inheritdoc}
28		*/
29	2	public function middlewares(array $middlewares) : MiddlewareAwareInterface
30		{
31	2	foreach ($middlewares as $middleware) {
32	2	$this->middleware($middleware);
33		}
34
35	2	return $this;
36		}
37
38		/**
39		* {@inheritdoc}
40		*/
41	30	public function prependMiddleware(MiddlewareInterface $middleware) : MiddlewareAwareInterface
42		{
43	30	array_unshift($this->middleware, $middleware);
44
45	30	return $this;
46		}
47
48		/**
49		* Add a middleware as a class name to the stack
50		*
51		* @param string $middleware
52		*
53		* @return static
54		*/
55	2	public function lazyMiddleware(string $middleware) : MiddlewareAwareInterface
56		{
57	2	$this->middleware[] = $middleware;
58
59	2	return $this;
60		}
61
62		/**
63		* Add multiple middlewares as class names to the stack
64		*
65		* @param string[] $middlewares
66		*
67		* @return static
68		*/
69		public function lazyMiddlewares(array $middlewares) : MiddlewareAwareInterface
70		{
71		foreach ($middlewares as $middleware) {
72		$this->lazyMiddleware($middleware);
73		}
74
75		return $this;
76		}
77
78		/**
79		* Prepend a middleware as a class name to the stack
80		*
81		* @param string $middleware
82		*
83		* @return static
84		*/
85		public function lazyPrependMiddleware(string $middleware) : MiddlewareAwareInterface
86		{
87		array_unshift($this->middleware, $middleware);
88
89		return $this;
90		}
91
92		/**
93		* {@inheritdoc}
94		*/
95	30	public function shiftMiddleware() : MiddlewareInterface
96		{
97	30	return array_shift($this->middleware);
98		}
99
100		/**
101		* {@inheritdoc}
102		*/
103	32	public function getMiddlewareStack() : iterable
104		{
105	32	return $this->middleware;
106		}
107
108		/**
109		* Resolve a middleware implementation, optionally from a container
110		*
111		* @param \Psr\Http\Server\MiddlewareInterface\|string $middleware
112		* @param \Psr\Container\ContainerInterface\|null $container
113		*
114		* @return \Psr\Http\Server\MiddlewareInterface
115		*/
116	2	protected function resolveMiddleware($middleware, ?ContainerInterface $container = null) : MiddlewareInterface
117		{
118	2	if (is_null($container) && is_string($middleware) && class_exists($middleware)) {
119	2	$middleware = new $middleware;
120		}
121
122	2	if (! is_null($container) && is_string($middleware) && $container->has($middleware)) {
123		$middleware = $container->get($middleware);
124		}
125
126	2	if ($middleware instanceof MiddlewareInterface) {
		1 ignored issue – show Bug introduced 2018-10-16 14:23 UTC by Report Bug Copy Issue Report The class `Psr\Http\Server\MiddlewareInterface` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
127	2	return $middleware;
128		}
129
130		throw new InvalidArgumentException(sprintf('Could not resolve middleware class: %s', $middleware));
131		}
132		}
133

thephpleague / route

Pull Request — master (#218)

MiddlewareAwareTrait::lazyMiddlewares() A

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like