mirror of
https://github.com/skipperbent/simple-php-router.git
synced 2026-06-17 08:47:52 +00:00
[BUGFIX] Fixed method not allowed exception.
- Method request type are now checked on all classes in the RouterBase class.
This commit is contained in:
@@ -25,10 +25,6 @@ Add the latest version pf Simple PHP Router to your ```composer.json```
|
|||||||
- CSRF Protection
|
- CSRF Protection
|
||||||
- Optional/required parameters
|
- Optional/required parameters
|
||||||
|
|
||||||
### Known issues
|
|
||||||
|
|
||||||
- Posting invalid/unsupported request-type throws 404 instead of "method not allowed" exception, unless defined within a group.
|
|
||||||
|
|
||||||
## Initialising the router
|
## Initialising the router
|
||||||
|
|
||||||
In your ```index.php``` require your ```routes.php``` and call the ```routeRequest()``` method when all your custom routes has been loaded. This will trigger and do the actual routing of the requests.
|
In your ```index.php``` require your ```routes.php``` and call the ```routeRequest()``` method when all your custom routes has been loaded. This will trigger and do the actual routing of the requests.
|
||||||
@@ -197,7 +193,7 @@ The router can be easily extended to customize your needs.
|
|||||||
|
|
||||||
## The MIT License (MIT)
|
## The MIT License (MIT)
|
||||||
|
|
||||||
Copyright (c) 2015 Simon Sessingø / simple-php-router
|
Copyright (c) 2015 Simon Sessing� / simple-php-router
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
|||||||
@@ -94,16 +94,32 @@ class RouterBase {
|
|||||||
return strcmp($b->getUrl(), $a->getUrl());
|
return strcmp($b->getUrl(), $a->getUrl());
|
||||||
});
|
});
|
||||||
|
|
||||||
|
$routeNotAllowed = false;
|
||||||
|
|
||||||
|
/* @var $route RouterEntry */
|
||||||
foreach($this->controllerUrlMap as $route) {
|
foreach($this->controllerUrlMap as $route) {
|
||||||
$routeMatch = $route->matchRoute($this->request);
|
$routeMatch = $route->matchRoute($this->request);
|
||||||
|
|
||||||
|
|
||||||
if($routeMatch && !($routeMatch instanceof RouterGroup)) {
|
if($routeMatch && !($routeMatch instanceof RouterGroup)) {
|
||||||
|
|
||||||
|
if(count($route->getRequestMethods()) && !in_array($this->request->getMethod(), $route->getRequestMethods())) {
|
||||||
|
$routeNotAllowed = true;
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
$routeNotAllowed = false;
|
||||||
|
|
||||||
$this->loadedRoute = $routeMatch;
|
$this->loadedRoute = $routeMatch;
|
||||||
$routeMatch->renderRoute($this->request);
|
$routeMatch->renderRoute($this->request);
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if($routeNotAllowed) {
|
||||||
|
throw new RouterException('Route or method not allowed', 403);
|
||||||
|
}
|
||||||
|
|
||||||
if(!$this->loadedRoute) {
|
if(!$this->loadedRoute) {
|
||||||
throw new RouterException(sprintf('Route not found: %s', $this->request->getUri()), 404);
|
throw new RouterException(sprintf('Route not found: %s', $this->request->getUri()), 404);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -27,6 +27,7 @@ abstract class RouterEntry {
|
|||||||
|
|
||||||
public function __construct() {
|
public function __construct() {
|
||||||
$this->settings = array();
|
$this->settings = array();
|
||||||
|
$this->settings['requestMethods'] = array();
|
||||||
$this->parameters = array();
|
$this->parameters = array();
|
||||||
$this->parametersRegex = array();
|
$this->parametersRegex = array();
|
||||||
}
|
}
|
||||||
@@ -193,8 +194,10 @@ abstract class RouterEntry {
|
|||||||
* @param array $settings
|
* @param array $settings
|
||||||
* @return self
|
* @return self
|
||||||
*/
|
*/
|
||||||
public function addSettings(array $settings) {
|
public function addSettings(array $settings = null) {
|
||||||
$this->settings = array_merge($this->settings, $settings);
|
if(is_array($settings)) {
|
||||||
|
$this->settings = array_merge($this->settings, $settings);
|
||||||
|
}
|
||||||
return $this;
|
return $this;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -280,6 +283,30 @@ abstract class RouterEntry {
|
|||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set allowed request methods
|
||||||
|
*
|
||||||
|
* @param array $methods
|
||||||
|
* @return self $this
|
||||||
|
*/
|
||||||
|
public function setRequestMethods(array $methods) {
|
||||||
|
$this->settings['requestMethods'] = $methods;
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get allowed requeset methods
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
public function getRequestMethods() {
|
||||||
|
if(!isset($this->settings['requestMethods']) || isset($this->settings['requestMethods']) && !is_array($this->settings['requestMethods'])) {
|
||||||
|
$value = isset($this->settings['requestMethods']) ? $this->settings['requestMethods'] : null;
|
||||||
|
return array($value);
|
||||||
|
}
|
||||||
|
return $this->settings['requestMethods'];
|
||||||
|
}
|
||||||
|
|
||||||
abstract function matchRoute(Request $request);
|
abstract function matchRoute(Request $request);
|
||||||
|
|
||||||
}
|
}
|
||||||
@@ -19,9 +19,9 @@ class RouterGroup extends RouterEntry {
|
|||||||
|
|
||||||
if($this->method) {
|
if($this->method) {
|
||||||
if(is_array($this->method)) {
|
if(is_array($this->method)) {
|
||||||
$hasAccess = (in_array($request->getMethod(), $this->method));
|
$hasAccess = (in_array($request->getMethod(), $this->getRequestMethods()));
|
||||||
} else {
|
} else {
|
||||||
$hasAccess = strtolower($this->method) == strtolower($request->getMethod());
|
$hasAccess = strtolower($this->getRequestMethods()) == strtolower($request->getMethod());
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -9,7 +9,6 @@ class RouterRoute extends RouterEntry {
|
|||||||
const PARAMETERS_REGEX_MATCH = '{([A-Za-z\-\_]*?)}';
|
const PARAMETERS_REGEX_MATCH = '{([A-Za-z\-\_]*?)}';
|
||||||
|
|
||||||
protected $url;
|
protected $url;
|
||||||
protected $requestTypes;
|
|
||||||
|
|
||||||
public function __construct($url, $callback) {
|
public function __construct($url, $callback) {
|
||||||
parent::__construct();
|
parent::__construct();
|
||||||
@@ -17,7 +16,6 @@ class RouterRoute extends RouterEntry {
|
|||||||
$this->setCallback($callback);
|
$this->setCallback($callback);
|
||||||
|
|
||||||
$this->settings['aliases'] = array();
|
$this->settings['aliases'] = array();
|
||||||
$this->requestTypes = array();
|
|
||||||
}
|
}
|
||||||
|
|
||||||
protected function parseParameters($url, $multiple = false, $regex = self::PARAMETERS_REGEX_MATCH) {
|
protected function parseParameters($url, $multiple = false, $regex = self::PARAMETERS_REGEX_MATCH) {
|
||||||
@@ -39,71 +37,69 @@ class RouterRoute extends RouterEntry {
|
|||||||
public function matchRoute(Request $request) {
|
public function matchRoute(Request $request) {
|
||||||
|
|
||||||
// Check if request method is allowed
|
// Check if request method is allowed
|
||||||
if(count($this->requestTypes) === 0 || in_array($request->getMethod(), $this->requestTypes)) {
|
|
||||||
|
|
||||||
$url = parse_url($request->getUri());
|
$url = parse_url($request->getUri());
|
||||||
$url = $url['path'];
|
$url = $url['path'];
|
||||||
|
|
||||||
$route = $this->url;
|
$route = $this->url;
|
||||||
|
|
||||||
$routeMatch = preg_replace('/'.self::PARAMETERS_REGEX_MATCH.'/is', '', $route);
|
$routeMatch = preg_replace('/'.self::PARAMETERS_REGEX_MATCH.'/is', '', $route);
|
||||||
|
|
||||||
// Check if url parameter count matches
|
// Check if url parameter count matches
|
||||||
if(stripos($url, $routeMatch) === 0) {
|
if(stripos($url, $routeMatch) === 0) {
|
||||||
|
|
||||||
$matches = true;
|
$matches = true;
|
||||||
|
|
||||||
if($this->regexMatch) {
|
if($this->regexMatch) {
|
||||||
$parameters = $this->parseParameters($url, true, $this->regexMatch);
|
$parameters = $this->parseParameters($url, true, $this->regexMatch);
|
||||||
|
|
||||||
// If regex doesn't match, make sure to return an array
|
|
||||||
if(!is_array($parameters)) {
|
|
||||||
$parameters = array();
|
|
||||||
}
|
|
||||||
|
|
||||||
} else {
|
|
||||||
|
|
||||||
$url = explode('/', $url);
|
|
||||||
$route = explode('/', $route);
|
|
||||||
|
|
||||||
|
// If regex doesn't match, make sure to return an array
|
||||||
|
if(!is_array($parameters)) {
|
||||||
$parameters = array();
|
$parameters = array();
|
||||||
|
}
|
||||||
|
|
||||||
// Check if url matches
|
} else {
|
||||||
foreach ($route as $i => $path) {
|
|
||||||
$parameter = $this->parseParameters($path, false);
|
|
||||||
|
|
||||||
// Check if parameter of path matches, otherwise quit..
|
$url = explode('/', $url);
|
||||||
if (is_null($parameter) && strtolower($path) != strtolower($url[$i])) {
|
$route = explode('/', $route);
|
||||||
$matches = false;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Save parameter if we have one
|
$parameters = array();
|
||||||
if ($parameter) {
|
|
||||||
$parameterValue = $url[$i];
|
|
||||||
$regex = (isset($this->parametersRegex[$parameter]) ? $this->parametersRegex[$parameter] : null);
|
|
||||||
|
|
||||||
if ($regex !== null) {
|
// Check if url matches
|
||||||
// Use the regular expression rule provided to filter the value
|
foreach ($route as $i => $path) {
|
||||||
$matches = array();
|
$parameter = $this->parseParameters($path, false);
|
||||||
preg_match('/' . $regex . '/is', $url[$i], $matches);
|
|
||||||
|
|
||||||
if (count($matches)) {
|
// Check if parameter of path matches, otherwise quit..
|
||||||
$parameterValue = $matches[0];
|
if (is_null($parameter) && strtolower($path) != strtolower($url[$i])) {
|
||||||
}
|
$matches = false;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Save parameter if we have one
|
||||||
|
if ($parameter) {
|
||||||
|
$parameterValue = $url[$i];
|
||||||
|
$regex = (isset($this->parametersRegex[$parameter]) ? $this->parametersRegex[$parameter] : null);
|
||||||
|
|
||||||
|
if ($regex !== null) {
|
||||||
|
// Use the regular expression rule provided to filter the value
|
||||||
|
$matches = array();
|
||||||
|
preg_match('/' . $regex . '/is', $url[$i], $matches);
|
||||||
|
|
||||||
|
if (count($matches)) {
|
||||||
|
$parameterValue = $matches[0];
|
||||||
}
|
}
|
||||||
|
|
||||||
// Add parameter value
|
|
||||||
$parameters[$parameter] = $parameterValue;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Add parameter value
|
||||||
|
$parameters[$parameter] = $parameterValue;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// This route matches
|
// This route matches
|
||||||
if($matches) {
|
if($matches) {
|
||||||
$this->parameters = $parameters;
|
$this->parameters = $parameters;
|
||||||
return $this;
|
return $this;
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -136,29 +132,6 @@ class RouterRoute extends RouterEntry {
|
|||||||
return $this;
|
return $this;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Add request type
|
|
||||||
*
|
|
||||||
* @param $type
|
|
||||||
* @return self
|
|
||||||
* @throws RouterException
|
|
||||||
*/
|
|
||||||
public function addRequestType($type) {
|
|
||||||
if(!in_array($type, self::$allowedRequestTypes)) {
|
|
||||||
throw new RouterException('Invalid request method: ' . $type);
|
|
||||||
}
|
|
||||||
|
|
||||||
$this->requestTypes[] = $type;
|
|
||||||
return $this;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @return mixed
|
|
||||||
*/
|
|
||||||
public function getRequestTypes() {
|
|
||||||
return $this->requestTypes;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get alias for the url which can be used when getting the url route.
|
* Get alias for the url which can be used when getting the url route.
|
||||||
* @return string
|
* @return string
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ class SimpleRouter {
|
|||||||
public static function get($url, $callback, array $settings = null) {
|
public static function get($url, $callback, array $settings = null) {
|
||||||
$route = new RouterRoute($url, $callback);
|
$route = new RouterRoute($url, $callback);
|
||||||
$route->addSettings($settings);
|
$route->addSettings($settings);
|
||||||
$route->addRequestType(RouterRoute::REQUEST_TYPE_GET);
|
$route->setRequestMethods(array(RouterRoute::REQUEST_TYPE_GET));
|
||||||
|
|
||||||
$router = RouterBase::getInstance();
|
$router = RouterBase::getInstance();
|
||||||
$router->addRoute($route);
|
$router->addRoute($route);
|
||||||
@@ -31,7 +31,7 @@ class SimpleRouter {
|
|||||||
public static function post($url, $callback, array $settings = null) {
|
public static function post($url, $callback, array $settings = null) {
|
||||||
$route = new RouterRoute($url, $callback);
|
$route = new RouterRoute($url, $callback);
|
||||||
$route->addSettings($settings);
|
$route->addSettings($settings);
|
||||||
$route->addRequestType(RouterRoute::REQUEST_TYPE_POST);
|
$route->setRequestMethods(array(RouterRoute::REQUEST_TYPE_POST));
|
||||||
|
|
||||||
$router = RouterBase::getInstance();
|
$router = RouterBase::getInstance();
|
||||||
$router->addRoute($route);
|
$router->addRoute($route);
|
||||||
@@ -42,7 +42,7 @@ class SimpleRouter {
|
|||||||
public static function put($url, $callback, array $settings = null) {
|
public static function put($url, $callback, array $settings = null) {
|
||||||
$route = new RouterRoute($url, $callback);
|
$route = new RouterRoute($url, $callback);
|
||||||
$route->addSettings($settings);
|
$route->addSettings($settings);
|
||||||
$route->addRequestType(RouterRoute::REQUEST_TYPE_PUT);
|
$route->setRequestMethods(array(RouterRoute::REQUEST_TYPE_PUT));
|
||||||
|
|
||||||
$router = RouterBase::getInstance();
|
$router = RouterBase::getInstance();
|
||||||
$router->addRoute($route);
|
$router->addRoute($route);
|
||||||
@@ -53,7 +53,7 @@ class SimpleRouter {
|
|||||||
public static function delete($url, $callback, array $settings = null) {
|
public static function delete($url, $callback, array $settings = null) {
|
||||||
$route = new RouterRoute($url, $callback);
|
$route = new RouterRoute($url, $callback);
|
||||||
$route->addSettings($settings);
|
$route->addSettings($settings);
|
||||||
$route->addRequestType(RouterRoute::REQUEST_TYPE_DELETE);
|
$route->setRequestMethods(array(RouterRoute::REQUEST_TYPE_DELETE));
|
||||||
|
|
||||||
$router = RouterBase::getInstance();
|
$router = RouterBase::getInstance();
|
||||||
$router->addRoute($route);
|
$router->addRoute($route);
|
||||||
@@ -75,12 +75,10 @@ class SimpleRouter {
|
|||||||
return $group;
|
return $group;
|
||||||
}
|
}
|
||||||
|
|
||||||
public static function match(array $requestTypes, $url, $callback, array $settings = null) {
|
public static function match(array $requestMethods, $url, $callback, array $settings = null) {
|
||||||
$route = new RouterRoute($url, $callback);
|
$route = new RouterRoute($url, $callback);
|
||||||
|
$route->setRequestMethods($requestMethods);
|
||||||
$route->addSettings($settings);
|
$route->addSettings($settings);
|
||||||
foreach($requestTypes as $requestType) {
|
|
||||||
$route->addRequestType($requestType);
|
|
||||||
}
|
|
||||||
|
|
||||||
$router = RouterBase::getInstance();
|
$router = RouterBase::getInstance();
|
||||||
$router->addRoute($route);
|
$router->addRoute($route);
|
||||||
|
|||||||
Reference in New Issue
Block a user