2012-11-22 13:41:50 -07:00
|
|
|
<?php
|
|
|
|
/**
|
|
|
|
* Slim - a micro PHP 5 framework
|
|
|
|
*
|
2012-11-22 14:19:06 -07:00
|
|
|
* @author Josh Lockhart <info@joshlockhart.com>
|
2012-11-22 13:41:50 -07:00
|
|
|
* @copyright 2011 Josh Lockhart
|
|
|
|
* @link http://www.slimframework.com
|
|
|
|
* @license http://www.slimframework.com/license
|
2012-11-22 14:19:06 -07:00
|
|
|
* @version 1.5.0
|
2012-11-22 13:41:50 -07:00
|
|
|
*
|
|
|
|
* MIT LICENSE
|
|
|
|
*
|
|
|
|
* Permission is hereby granted, free of charge, to any person obtaining
|
|
|
|
* a copy of this software and associated documentation files (the
|
|
|
|
* "Software"), to deal in the Software without restriction, including
|
|
|
|
* without limitation the rights to use, copy, modify, merge, publish,
|
|
|
|
* distribute, sublicense, and/or sell copies of the Software, and to
|
|
|
|
* permit persons to whom the Software is furnished to do so, subject to
|
|
|
|
* the following conditions:
|
|
|
|
*
|
|
|
|
* The above copyright notice and this permission notice shall be
|
|
|
|
* included in all copies or substantial portions of the Software.
|
|
|
|
*
|
|
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
|
|
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
|
|
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
|
|
|
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
|
|
|
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
|
|
|
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Router
|
|
|
|
*
|
2012-11-22 14:19:06 -07:00
|
|
|
* Responsible for registering route paths with associated callables.
|
|
|
|
* When a Slim application is run, the Router finds a matching Route for
|
|
|
|
* the current HTTP request, and if a matching route is found, executes
|
|
|
|
* the Route's associated callable passing it parameters from the Request URI.
|
2012-11-22 13:41:50 -07:00
|
|
|
*
|
|
|
|
* @package Slim
|
2012-11-22 14:19:06 -07:00
|
|
|
* @author Josh Lockhart <info@joshlockhart.com>
|
|
|
|
* @since Version 1.0
|
2012-11-22 13:41:50 -07:00
|
|
|
*/
|
2012-11-22 14:19:06 -07:00
|
|
|
class Slim_Router implements IteratorAggregate {
|
|
|
|
|
2012-11-22 13:41:50 -07:00
|
|
|
/**
|
2012-11-22 14:19:06 -07:00
|
|
|
* @var Slim_Http_Request
|
2012-11-22 13:41:50 -07:00
|
|
|
*/
|
2012-11-22 14:19:06 -07:00
|
|
|
protected $request;
|
2012-11-22 13:41:50 -07:00
|
|
|
|
|
|
|
/**
|
2012-11-22 14:19:06 -07:00
|
|
|
* @var array Lookup hash of routes, keyed by Request method
|
2012-11-22 13:41:50 -07:00
|
|
|
*/
|
|
|
|
protected $routes;
|
|
|
|
|
|
|
|
/**
|
2012-11-22 14:19:06 -07:00
|
|
|
* @var array Lookup hash of named routes, keyed by route name
|
2012-11-22 13:41:50 -07:00
|
|
|
*/
|
|
|
|
protected $namedRoutes;
|
|
|
|
|
|
|
|
/**
|
2012-11-22 14:19:06 -07:00
|
|
|
* @var array Array of routes that match the Request method and URL
|
2012-11-22 13:41:50 -07:00
|
|
|
*/
|
|
|
|
protected $matchedRoutes;
|
|
|
|
|
|
|
|
/**
|
2012-11-22 14:19:06 -07:00
|
|
|
* @var mixed Callable to be invoked if no matching routes are found
|
2012-11-22 13:41:50 -07:00
|
|
|
*/
|
|
|
|
protected $notFound;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @var mixed Callable to be invoked if application error
|
|
|
|
*/
|
|
|
|
protected $error;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Constructor
|
2012-11-22 14:19:06 -07:00
|
|
|
* @param Slim_Http_Request $request The HTTP request object
|
2012-11-22 13:41:50 -07:00
|
|
|
*/
|
2012-11-22 14:19:06 -07:00
|
|
|
public function __construct( Slim_Http_Request $request ) {
|
|
|
|
$this->request = $request;
|
2012-11-22 13:41:50 -07:00
|
|
|
$this->routes = array();
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2012-11-22 14:19:06 -07:00
|
|
|
* Get Iterator
|
|
|
|
* @return ArrayIterator
|
2012-11-22 13:41:50 -07:00
|
|
|
*/
|
2012-11-22 14:19:06 -07:00
|
|
|
public function getIterator() {
|
|
|
|
return new ArrayIterator($this->getMatchedRoutes());
|
2012-11-22 13:41:50 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2012-11-22 14:19:06 -07:00
|
|
|
* Get Request
|
|
|
|
* @return Slim_Http_Request
|
2012-11-22 13:41:50 -07:00
|
|
|
*/
|
2012-11-22 14:19:06 -07:00
|
|
|
public function getRequest() {
|
|
|
|
return $this->request;
|
|
|
|
}
|
2012-11-22 13:41:50 -07:00
|
|
|
|
2012-11-22 14:19:06 -07:00
|
|
|
/**
|
|
|
|
* Set Request
|
|
|
|
* @param Slim_Http_Request $req
|
|
|
|
* @return void
|
|
|
|
*/
|
|
|
|
public function setRequest( Slim_Http_Request $req ) {
|
|
|
|
$this->request = $req;
|
2012-11-22 13:41:50 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2012-11-22 14:19:06 -07:00
|
|
|
* Return routes that match the current request
|
|
|
|
* @return array[Slim_Route]
|
2012-11-22 13:41:50 -07:00
|
|
|
*/
|
2012-11-22 14:19:06 -07:00
|
|
|
public function getMatchedRoutes( $reload = false ) {
|
|
|
|
if ( $reload || is_null($this->matchedRoutes) ) {
|
2012-11-22 13:41:50 -07:00
|
|
|
$this->matchedRoutes = array();
|
2012-11-22 14:19:06 -07:00
|
|
|
foreach ( $this->routes as $route ) {
|
|
|
|
if ( $route->matches($this->request->getResourceUri()) ) {
|
2012-11-22 13:41:50 -07:00
|
|
|
$this->matchedRoutes[] = $route;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return $this->matchedRoutes;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2012-11-22 14:19:06 -07:00
|
|
|
* Map a route to a callback function
|
|
|
|
* @param string $pattern The URL pattern (ie. "/books/:id")
|
|
|
|
* @param mixed $callable Anything that returns TRUE for is_callable()
|
|
|
|
* @return Slim_Route
|
2012-11-22 13:41:50 -07:00
|
|
|
*/
|
2012-11-22 14:19:06 -07:00
|
|
|
public function map( $pattern, $callable ) {
|
|
|
|
$route = new Slim_Route($pattern, $callable);
|
|
|
|
$route->setRouter($this);
|
2012-11-22 13:41:50 -07:00
|
|
|
$this->routes[] = $route;
|
|
|
|
return $route;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2012-11-22 14:19:06 -07:00
|
|
|
* Cache named route
|
|
|
|
* @param string $name The route name
|
|
|
|
* @param Slim_Route $route The route object
|
|
|
|
* @throws RuntimeException If a named route already exists with the same name
|
|
|
|
* @return void
|
2012-11-22 13:41:50 -07:00
|
|
|
*/
|
2012-11-22 14:19:06 -07:00
|
|
|
public function cacheNamedRoute( $name, Slim_Route $route ) {
|
|
|
|
if ( isset($this->namedRoutes[(string)$name]) ) {
|
|
|
|
throw new RuntimeException('Named route already exists with name: ' . $name);
|
2012-11-22 13:41:50 -07:00
|
|
|
}
|
2012-11-22 14:19:06 -07:00
|
|
|
$this->namedRoutes[$name] = $route;
|
2012-11-22 13:41:50 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2012-11-22 14:19:06 -07:00
|
|
|
* Get URL for named route
|
|
|
|
* @param string $name The name of the route
|
|
|
|
* @param array Associative array of URL parameter names and values
|
|
|
|
* @throws RuntimeException If named route not found
|
|
|
|
* @return string The URL for the given route populated with the given parameters
|
|
|
|
*/
|
|
|
|
public function urlFor( $name, $params = array() ) {
|
|
|
|
if ( !isset($this->namedRoutes[(string)$name]) ) {
|
|
|
|
throw new RuntimeException('Named route not found for name: ' . $name);
|
2012-11-22 13:41:50 -07:00
|
|
|
}
|
2012-11-22 14:19:06 -07:00
|
|
|
$pattern = $this->namedRoutes[(string)$name]->getPattern();
|
|
|
|
$search = $replace = array();
|
|
|
|
foreach ( $params as $key => $value ) {
|
|
|
|
$search[] = ':' . $key;
|
|
|
|
$replace[] = $value;
|
2012-11-22 13:41:50 -07:00
|
|
|
}
|
2012-11-22 14:19:06 -07:00
|
|
|
$pattern = str_replace($search, $replace, $pattern);
|
|
|
|
//Remove remnants of unpopulated, trailing optional pattern segments
|
|
|
|
return preg_replace(array(
|
|
|
|
'@\(\/?:.+\/??\)\??@',
|
|
|
|
'@\?|\(|\)@'
|
|
|
|
), '', $this->request->getRootUri() . $pattern);
|
2012-11-22 13:41:50 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Register a 404 Not Found callback
|
2012-11-22 14:19:06 -07:00
|
|
|
* @param mixed $callable Anything that returns TRUE for is_callable()
|
|
|
|
* @return mixed
|
2012-11-22 13:41:50 -07:00
|
|
|
*/
|
2012-11-22 14:19:06 -07:00
|
|
|
public function notFound( $callable = null ) {
|
|
|
|
if ( is_callable($callable) ) {
|
2012-11-22 13:41:50 -07:00
|
|
|
$this->notFound = $callable;
|
|
|
|
}
|
|
|
|
return $this->notFound;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Register a 500 Error callback
|
2012-11-22 14:19:06 -07:00
|
|
|
* @param mixed $callable Anything that returns TRUE for is_callable()
|
|
|
|
* @return mixed
|
2012-11-22 13:41:50 -07:00
|
|
|
*/
|
2012-11-22 14:19:06 -07:00
|
|
|
public function error( $callable = null ) {
|
|
|
|
if ( is_callable($callable) ) {
|
2012-11-22 13:41:50 -07:00
|
|
|
$this->error = $callable;
|
|
|
|
}
|
|
|
|
return $this->error;
|
|
|
|
}
|
|
|
|
|
2012-11-22 14:19:06 -07:00
|
|
|
}
|