40 lines
1.0 KiB
PHP
40 lines
1.0 KiB
PHP
<?php
|
|
|
|
namespace WellRESTed\Routing\Route;
|
|
|
|
use WellRESTed\Routing\MethodMapInterface;
|
|
use WellRESTed\Routing\MiddlewareInterface;
|
|
|
|
interface RouteInterface extends MiddlewareInterface
|
|
{
|
|
const TYPE_STATIC = 0;
|
|
const TYPE_PREFIX = 1;
|
|
const TYPE_PATTERN = 2;
|
|
|
|
public function getTarget();
|
|
|
|
public function getType();
|
|
|
|
/**
|
|
* Return the instance mapping methods to middleware for this route.
|
|
*
|
|
* @return MethodMapInterface
|
|
*/
|
|
public function getMethodMap();
|
|
|
|
/**
|
|
* Examines a path (request target) and returns whether or not the route
|
|
* should handle the request providing the target.
|
|
*
|
|
* If a successful examination also extracts items (such as captures from
|
|
* matching a regular expression), store them to $captures.
|
|
*
|
|
* $captures should have no meaning for calls that return false.
|
|
*
|
|
* @param string $requestTarget
|
|
* @param array $captures
|
|
* @return boolean
|
|
*/
|
|
public function matchesRequestTarget($requestTarget, &$captures = null);
|
|
}
|