Nymfonya\Component\Http\Interfaces\RouterInterface

Size/Duplication

Total Lines	51
Duplicated Lines	0 %

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
	__construct()	0	1	?
	setRoutes()	0	1	?
	compile()	0	1	?
	getParams()	0	1	?
	setParams()	0	1	?
	getMatchingRoute()	0	1	?

<?php

declare(strict_types=1);

namespace Nymfonya\Component\Http\Interfaces;

use Nymfonya\Component\Http\Interfaces\RequestInterface;
use Nymfonya\Component\Http\Interfaces\RouteInterface;
use Nymfonya\Component\Http\Interfaces\RoutesInterface;

interface RouterInterface
{
    const URI_SEPARATOR = '/';
    const REQUEST_URI = 'REQUEST_URI';

    /**
     * instanciate
     *
     * @param RoutesInterface $routes
     * @param RequestInterface $request
     */
    public function __construct(RoutesInterface $routes, RequestInterface $request);

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

    /**
     * assign routes to router
     *
     * @param RoutesInterface $routes
     * @return RouterInterface
     */
    public function setRoutes(RoutesInterface $routes): RouterInterface;

    /**
     * compiles routes
     *
     * @return array
     */
    public function compile(): array;

    /**
     * return slugs params
     *
     * @return array
     */
    public function getParams(): array;

    /**
     * set params from slugs
     *
     * @param RouteInterface $route
     * @param array $matches
     * @return RouterInterface
     */
    public function setParams(RouteInterface $route, array $matches): RouterInterface;

    /**
     * return matching regexp pattern
     *
     * @return string
     */
    public function getMatchingRoute(): string;
}