Yiisoft\Router\Handler\HandlerAwareTrait

Complexity

Total Complexity

5

Size/Duplication

Total Lines	62
Duplicated Lines	0 %

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	prependHandler()	0	5	1
A	handlers()	0	7	2
A	handler()	0	5	1
A	getHandlers()	0	3	1

<?php

declare(strict_types=1);

namespace Yiisoft\Router\Handler;

use Psr\Http\Server\MiddlewareInterface;

use function array_unshift;

trait HandlerAwareTrait
{
    private array $handlers = [];

    /**
     * Add handler that should be invoked for the route when match happens to the stack.
     *
     * @param mixed $handler that will be added.
     * Handler type and format support depends on the \Yiisoft\Router\Dispatcher\DispatcherInterface implementation.
     * @param bool $validate whether to validate handler before execution
     *
     * @return HandlerAwareInterface
     */
    public function handler($handler, $validate = false): HandlerAwareInterface

The parameter $validate is not used and could be removed.

    {
        $this->handlers[] = $handler;

        return $this;

The expression return $this returns the type Yiisoft\Router\Handler\HandlerAwareTrait which is incompatible with the type-hinted return Yiisoft\Router\Handler\HandlerAwareInterface.

    }

    /**
     * Add multiple handlers that should be invoked for the route when match happens to the stack.
     *
     * @param array $handlers that will be added.
     * Handler type and format support depends on the \Yiisoft\Router\Dispatcher\DispatcherInterface implementation.
     * @param false $validate whether to validate handlers before execution
     *
     * @return HandlerAwareInterface
     */
    public function handlers(iterable $handlers, $validate = false): HandlerAwareInterface
    {
        foreach ($handlers as $handler) {
            $this->handler($handler, $validate);
        }

        return $this;

The expression return $this returns the type Yiisoft\Router\Handler\HandlerAwareTrait which is incompatible with the type-hinted return Yiisoft\Router\Handler\HandlerAwareInterface.

    }

    /**
     * Prepend handler that should be invoked for the route when match happens to the stack.
     *
     * @param mixed $handler that will be added.
     * Handler type and format support depends on the \Yiisoft\Router\Dispatcher\DispatcherInterface implementation.
     * @param bool $validate whether to validate handler before execution
     *
     * @return HandlerAwareInterface
     */
    public function prependHandler($handler, $validate = false): HandlerAwareInterface

The parameter $validate is not used and could be removed.

    {
        array_unshift($this->handlers, $handler);

        return $this;

The expression return $this returns the type Yiisoft\Router\Handler\HandlerAwareTrait which is incompatible with the type-hinted return Yiisoft\Router\Handler\HandlerAwareInterface.

    }

    /**
     * Get the stack of handlers that should be invoked for the route when match happens.
     *
     * @return iterable stack of handlers.
     */
    public function getHandlers(): iterable
    {
        return $this->handlers;
    }
}