burzum / php-router

src/Middleware/RouterMiddleware.php

<?php
declare(strict_types=1);

namespace Lead\Router\Middleware;

use Lead\Router\Exception\RouteNotFoundException;
use Lead\Router\RouterInterface;
use Psr\Http\Server\MiddlewareInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\RequestHandlerInterface;
use Psr\Http\Message\ResponseInterface;

/**
 * RouterMiddleware
 */
class RouterMiddleware implements MiddlewareInterface
{
    /**
     * Router
     *
     * @var \Lead\Router\Router
     */
    protected $router;

    /**
     * Not found callback
     *
     * @var callable
     */
    protected $notFoundCallback = null;

    /**
     * Ignore the exception
     *
     * @var bool
     */
    protected $ignoreNotFoundException = false;

    /**
     * The request attribute name for the route
     *
     * @var string
     */
    protected $routeAttribute = 'route';

    /**
     * Constructor
     *
     * @param \Lead\Router\RouterInterface $router Router
     */
    public function __construct(
        RouterInterface $router
    ) {
        $this->router = $router;

$router is of type Lead\Router\RouterInterface, but the property $router was declared to be of type Lead\Router\Router. Are you sure that you always receive this specific sub-class here, or does it make sense to add an instanceof check?

    }

    /**
     * Sets the request attribute name for the route object
     *
     * @param string $name Name
     * @return $this
     */
    public function setRouteAttribute(string $name): self
    {
        $this->routeAttribute = $name;

        return $this;
    }

    /**
     * Sets the flag to ignore the route not found exception
     *
     * @param bool $ignore Ignore
     * @return $this
     */
    public function setIgnoreException(bool $ignore): self
    {
        $this->ignoreNotFoundException = $ignore;

        return $this;
    }

    /**
     * Process an incoming server request and return a response, optionally
     * delegating response creation to a handler.
     *
     * @param \Psr\Http\Message\ServerRequestInterface $request Request
     * @param \Psr\Http\Server\RequestHandlerInterface $requestHandler Request Handler
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function process(ServerRequestInterface $request, RequestHandlerInterface $requestHandler): ResponseInterface
    {
        try {
            $route = $this->router->route($request);
            $request = $request->withAttribute($this->routeAttribute, $route);
        } catch (RouteNotFoundException $exception) {
            if (is_callable($this->notFoundCallback)) {
                $callable = $this->notFoundCallback;
                $result = $callable($request, $this->router);
                if ($result instanceof ResponseInterface) {
                    return $result;
                }
            }

            if (!$this->ignoreNotFoundException) {
                throw $exception;
            }
        }

        return $requestHandler->handle($request);
    }
}