League\Route\Middleware\MiddlewareAwareTrait

Complexity

Total Complexity

19

Size/Duplication

Total Lines	130
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

71.43%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	middleware()	0	6	1
A	middlewares()	0	8	2
A	prependMiddleware()	0	6	1
A	lazyMiddleware()	0	6	1
A	lazyMiddlewares()	0	8	2
A	lazyPrependMiddleware()	0	6	1
A	shiftMiddleware()	0	10	2
A	getMiddlewareStack()	0	4	1
B	resolveMiddleware()	0	16	8

<?php declare(strict_types=1);

namespace League\Route\Middleware;

use InvalidArgumentException;
use OutOfBoundsException;
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
    {
        $middleware =  array_shift($this->middleware);

        if ($middleware === null) {
            throw new OutOfBoundsException('Reached end of middleware stack. Does your controller return a response?');
        }

        return $middleware;
    }

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

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

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

        if ($middleware instanceof MiddlewareInterface) {
            return $middleware;
        }

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