177 lines
4.0 KiB
PHP
177 lines
4.0 KiB
PHP
<?php
|
|
|
|
/**
|
|
* pjdietz\WellRested\Route
|
|
*
|
|
* @author PJ Dietz <pj@pjdietz.com>
|
|
* @copyright Copyright 2013 by PJ Dietz
|
|
* @license MIT
|
|
*/
|
|
|
|
namespace pjdietz\WellRESTed;
|
|
|
|
use \Exception;
|
|
|
|
/**
|
|
* A Route connects a URI pattern to a Handler.
|
|
*/
|
|
class Route implements RouteInterface
|
|
{
|
|
/**
|
|
* Regular expression matching URL friendly characters (i.e., letters,
|
|
* digits, hyphen and underscore)
|
|
*/
|
|
const RE_SLUG = '[0-9a-zA-Z\-_]+';
|
|
|
|
/** Regular expression matching digitis */
|
|
const RE_NUM = '[0-9]+';
|
|
|
|
/** Regular expression matching letters */
|
|
const RE_ALPHA = '[a-zA-Z]+';
|
|
|
|
/** Regular expression matching letters and digits */
|
|
const RE_ALPHANUM = '[0-9a-zA-Z]+';
|
|
|
|
/** Regular expression matching a URI template variable (e.g., {id}) */
|
|
const URI_TEMPLATE_EXPRESSION_RE = '/{([a-zA-Z]+)}/';
|
|
|
|
/**
|
|
* Default regular expression used to match template variable
|
|
*
|
|
* @property string
|
|
*/
|
|
static public $defaultVariablePattern = self::RE_SLUG;
|
|
|
|
/**
|
|
* Regular expression used to match a Request URI path component
|
|
*
|
|
* @var string
|
|
*/
|
|
private $pattern;
|
|
|
|
/**
|
|
* Name of the Handler class to use
|
|
*
|
|
* @var string
|
|
*/
|
|
private $handler;
|
|
|
|
/**
|
|
* Create a new Route
|
|
*
|
|
* @param $pattern
|
|
* @param $handler
|
|
*/
|
|
public function __construct($pattern, $handler)
|
|
{
|
|
$this->pattern = $pattern;
|
|
$this->handler = $handler;
|
|
}
|
|
|
|
/**
|
|
* @param string $handler
|
|
*/
|
|
public function setHandler($handler)
|
|
{
|
|
$this->handler = $handler;
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
public function getHandler()
|
|
{
|
|
return $this->handler;
|
|
}
|
|
|
|
/**
|
|
* @param string $pattern
|
|
*/
|
|
public function setPattern($pattern)
|
|
{
|
|
$this->pattern = $pattern;
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
public function getPattern()
|
|
{
|
|
return $this->pattern;
|
|
}
|
|
|
|
/**
|
|
* Create a new Route using a URI template to generate the pattern.
|
|
*
|
|
* @param string $uriTemplate
|
|
* @param string $handler
|
|
* @param array $variables
|
|
* @throws Exception
|
|
* @return Route
|
|
*/
|
|
static public function newFromUriTemplate(
|
|
$uriTemplate,
|
|
$handler,
|
|
$variables = null
|
|
) {
|
|
|
|
$pattern = '';
|
|
|
|
// Explode the template into an array of path segments.
|
|
if ($uriTemplate[0] === '/') {
|
|
$parts = explode('/', substr($uriTemplate, 1));
|
|
} else {
|
|
$parts = explode('/', $uriTemplate);
|
|
}
|
|
|
|
foreach ($parts as $part) {
|
|
|
|
$pattern .= '\/';
|
|
|
|
// Is this part an expression or a literal?
|
|
if (preg_match(self::URI_TEMPLATE_EXPRESSION_RE, $part, $matches)) {
|
|
|
|
// This part of the path is an expresion.
|
|
|
|
if (count($matches) === 2) {
|
|
|
|
// Locate the name for the variable from the template.
|
|
$variableName = $matches[1];
|
|
|
|
// If the caller passed an array with this variable name
|
|
// as a key, use its value for the pattern here.
|
|
// Otherwise, use the class's current default.
|
|
if (isset($variables[$variableName])) {
|
|
$variablePattern = $variables[$variableName];
|
|
} else {
|
|
$variablePattern = self::$defaultVariablePattern;
|
|
}
|
|
|
|
$pattern .= sprintf(
|
|
'(?<%s>%s)',
|
|
$variableName,
|
|
$variablePattern
|
|
);
|
|
|
|
} else {
|
|
// Not sure why this would happen.
|
|
throw new Exception('Invalid URI Template.');
|
|
}
|
|
|
|
} else {
|
|
// This part is a literal.
|
|
$pattern .= $part;
|
|
}
|
|
|
|
}
|
|
|
|
$pattern = '/^' . $pattern . '$/';
|
|
|
|
$klass = __CLASS__;
|
|
$route = new $klass($pattern, $handler);
|
|
return $route;
|
|
|
|
}
|
|
|
|
}
|