merakiframework / route

src/Mapper.php

<?php
declare(strict_types=1);

namespace Meraki\Route;

use Meraki\Route\Collection;
use Psr\Http\Server\RequestHandlerInterface as RequestHandler;
use Closure;

/**
 * An in-memory store for route rules.
 *
 * @author Nathan Bishop <nbish11@hotmail.com> (https://nathanbishop.name)
 * @copyright 2019 Nathan Bishop
 * @license The MIT license.
 */
final class Mapper extends Collection
{
    /**
     * @var string The request-target prefix.
     */
    private $prefix = '';

    /**
     * Adds a route that responds to the 'HEAD' request method to the collection.
     *
     * @param string $requestTarget The path/pattern the route should respond to.
     * @param callable $handler The method/function to call when a route is matched.
     * @return Route The actual route object being added to the collection.

The type Meraki\Route\Route was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    public function head(string $requestTarget, RequestHandler $handler): Rule
    {
        return $this->map('HEAD', $requestTarget, $handler);

The expression return $this->map('HEAD', $requestTarget, $handler) returns the type Meraki\Route\Rule which is incompatible with the documented return type Meraki\Route\Route.

    }

    /**
     * Adds a route that responds to the 'GET' request method to the collection.
     *
     * @param string $requestTarget The path/pattern the route should respond to.
     * @param callable $handler The method/function to call when a route is matched.
     * @return Route The actual route object being added to the collection.
     */
    public function get(string $requestTarget, RequestHandler $handler): Rule
    {
        return $this->map('GET', $requestTarget, $handler);

The expression return $this->map('GET', $requestTarget, $handler) returns the type Meraki\Route\Rule which is incompatible with the documented return type Meraki\Route\Route.

    }

    /**
     * Adds a route that responds to the 'POST' request method to the collection.
     *
     * @param string $requestTarget The path/pattern the route should respond to.
     * @param callable $handler The method/function to call when a route is matched.
     * @return Route The actual route object being added to the collection.
     */
    public function post(string $requestTarget, RequestHandler $handler): Rule
    {
        return $this->map('POST', $requestTarget, $handler);

The expression return $this->map('POST', $requestTarget, $handler) returns the type Meraki\Route\Rule which is incompatible with the documented return type Meraki\Route\Route.

    }

    /**
     * Adds a route that responds to the 'PUT' request method to the collection.
     *
     * @param string $requestTarget The path/pattern the route should respond to.
     * @param callable $handler The method/function to call when a route is matched.
     * @return Route The actual route object being added to the collection.
     */
    public function put(string $requestTarget, RequestHandler $handler): Rule
    {
        return $this->map('PUT', $requestTarget, $handler);

The expression return $this->map('PUT', $requestTarget, $handler) returns the type Meraki\Route\Rule which is incompatible with the documented return type Meraki\Route\Route.

    }

    /**
     * Adds a route that responds to the 'PATCH' request method to the collection.
     *
     * @param string $requestTarget The path/pattern the route should respond to.
     * @param callable $handler The method/function to call when a route is matched.
     * @return Route The actual route object being added to the collection.
     */
    public function patch(string $requestTarget, RequestHandler $handler): Rule
    {
        return $this->map('PATCH', $requestTarget, $handler);

The expression return $this->map('PATCH', $requestTarget, $handler) returns the type Meraki\Route\Rule which is incompatible with the documented return type Meraki\Route\Route.

    }

    /**
     * Adds a route that responds to the 'DELETE' request method to the collection.
     *
     * @param string $requestTarget The path/pattern the route should respond to.
     * @param callable $handler The method/function to call when a route is matched.
     * @return Route The actual route object being added to the collection.
     */
    public function delete(string $requestTarget, RequestHandler $handler): Rule
    {
        return $this->map('DELETE', $requestTarget, $handler);

The expression return $this->map('DELETE', $requestTarget, $handler) returns the type Meraki\Route\Rule which is incompatible with the documented return type Meraki\Route\Route.

    }

    /**
     * Adds a route that responds to the 'OPTIONS' request method to the collection.
     *
     * @param string $requestTarget The path/pattern the route should respond to.
     * @param callable $handler The method/function to call when a route is matched.
     * @return Route The actual route object being added to the collection.
     */
    public function options(string $requestTarget, RequestHandler $handler): Rule
    {
        return $this->map('OPTIONS', $requestTarget, $handler);

The expression return $this->map('OPTIONS', $requestTarget, $handler) returns the type Meraki\Route\Rule which is incompatible with the documented return type Meraki\Route\Route.

    }

    /**
     * Add routes with a prefix attached to the request-target.
     *
     * @param string $prefix The request-target to be prefixed to every added route.
     * @param Closure $grouper Routes added from within this closure will be prefixed with the supplied request-target.
     */
    public function group(string $prefix, Closure $grouper): void
    {
        $previousPrefix = $this->prefix;
        $this->prefix = $previousPrefix . $prefix;

        $grouper->call($this);

        $this->prefix = $previousPrefix;
    }

    /**
     * Create a new route rule and add it to the collection.
     *
     * @param string $method The request method.
     * @param string $requestTarget The request target.
     * @param RequestHandler $handler The request handler.
     * @return Rule The rule that was created to match the request.
     */
    public function map(string $method, string $requestTarget, RequestHandler $handler): Rule
    {
        $rule = Rule::create($method, $this->prefix . $requestTarget, $handler);

        $this->add($rule);

        return $rule;
    }
}