[FEATURE] Optimised route matching, added optional parameters.

- Optimised route matching. This should be way more officient and also
  seems to fix issues with getting the current route using the getRoute class.

- Added support for optional routes, for example: {id?}.

- Updated documentation to reflect new changes.
This commit is contained in:
Simon Sessingø
2015-11-21 19:31:06 +01:00
parent b930c06683
commit 3b4954821a
4 changed files with 94 additions and 93 deletions
+8 -6
View File
@@ -28,12 +28,12 @@ Add the latest version pf Simple PHP Router to your ```composer.json```
- Namespaces.
- Route prefixes.
- CSRF protection.
- Optional parameters
### Features currently "in-the-works"
- Global Constraints
- Sub-Domain Routing
- Optional parameters
- Sub-domain routing
## Initialising the router
@@ -74,8 +74,10 @@ SimpleRouter::group(['prefix' => 'v1', 'middleware' => '\MyWebsite\Middleware\So
SimpleRouter::group(['prefix' => 'services'], function() {
SimpleRouter::get('/answers/{id}', 'ControllerAnswers@show')
->where(['id' => '[0-9]+');
SimpleRouter::get('/answers/{id}', 'ControllerAnswers@show')->where(['id' => '[0-9]+');
// Optional parameter
SimpleRouter::get('/answers/{id?}', 'ControllerAnswers@show');
/**
* This example will route url when matching the regular expression to the method.
@@ -83,7 +85,7 @@ SimpleRouter::group(['prefix' => 'v1', 'middleware' => '\MyWebsite\Middleware\So
*/
SimpleRouter::all('/ajax', 'ControllerAjax@process')->match('ajax\\/([A-Za-z0-9\\/]+)');
// Resetful resource
// Restful resource
SimpleRouter::resource('/rest', 'ControllerRessource');
// Load the entire controller (where url matches method names - getIndex(), postIndex() etc)
@@ -251,7 +253,7 @@ The router can be easily extended to customize your needs.
## 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
of this software and associated documentation files (the "Software"), to deal
+1 -1
View File
@@ -224,7 +224,7 @@ class RouterBase {
$i = 0;
foreach($params as $param => $value) {
$value = (isset($parameters[$param])) ? $parameters[$param] : $value;
$url = str_ireplace('{' . $param. '}', $value, $url);
$url = str_ireplace(array('{' . $param. '}', '{' . $param. '?}'), $value, $url);
$i++;
}
} else {
+84 -85
View File
@@ -18,98 +18,93 @@ class RouterRoute extends RouterEntry {
$this->settings['aliases'] = array();
}
protected function parseParameters($url, $multiple = false, $regex = self::PARAMETERS_REGEX_MATCH) {
$url = rtrim($url, '/');
$parameters = array();
if($multiple) {
preg_match_all('/'.$regex.'/is', $url, $parameters);
} else {
preg_match('/'.$regex.'/is', $url, $parameters);
}
if(isset($parameters[1]) && count($parameters[1]) > 0) {
return $parameters[1];
}
return null;
}
public function matchRoute(Request $request) {
// Check if request method is allowed
$url = parse_url($request->getUri());
$url = $url['path'];
$url = rtrim($url['path'], '/') . '/';
$route = rtrim($this->url, '/') . '/';
$routeMatch = preg_replace('/\/{0,1}'.self::PARAMETERS_REGEX_MATCH.'\/{0,1}/is', '', $route);
$tmp = explode('/', $route);
$tmp2 = explode('/', $url);
// Check if url parameter count matches
if(stripos($url, $routeMatch) === 0 || count($tmp) === count($tmp2)) {
$matches = true;
if($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 {
$matches = (count(explode('/', rtrim($url, '/'))) == count(explode('/', rtrim($route, '/'))));
$url = explode('/', $url);
$route = explode('/', rtrim($route, '/'));
$parameters = array();
// Check if url matches
foreach ($route as $i => $path) {
$parameter = $this->parseParameters($path, false);
// Check if parameter of path matches, otherwise quit..
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, if it doesn't exist - replace it with null value
$parameters[$parameter] = ($parameterValue === '') ? null : $parameterValue;
}
}
}
// This route matches
if($matches) {
$this->parameters = $parameters;
// Match on custom defined regular expression
if($this->regexMatch) {
$parameters = array();
if(preg_match('/'.$this->regexMatch.'/is', $url, $parameters)) {
$this->parameters = $parameters[0];
return $this;
}
}
// No match here, move on...
// Make regular expression based on route
$route = rtrim($this->url, '/') . '/';
$parameterNames = array();
$regex = '';
$lastCharacter = '';
$isParameter = false;
$parameter = '';
for($i = 0; $i < strlen($route); $i++) {
$character = $route[$i];
// Skip "/" if we are at the end of a parameter
if($lastCharacter === '}' && $character === '/') {
$lastCharacter = $character;
continue;
}
if($character === '{') {
// Remove "/" and "\" from regex
if(substr($regex, strlen($regex)-1) === '/') {
$regex = substr($regex, 0, strlen($regex) - 2);
}
$isParameter = true;
} elseif($isParameter && $character === '}') {
// Check for optional parameter
if($lastCharacter === '?') {
$parameter = substr($parameter, 0, strlen($parameter)-1);
$regex .= '(?:(?:\/(?P<'.$parameter.'>[0-9]*?)){0,1}\\/)';
} else {
// Use custom parameter regex if it exists
$parameterRegex = '[0-9]*?';
if(is_array($this->parametersRegex) && isset($this->parametersRegex[$parameter])) {
$parameterRegex = $this->parametersRegex[$parameter];
}
$regex .= '(?:\\/(?P<' . $parameter . '>'. $parameterRegex .')\\/)';
}
$parameterNames[] = $parameter;
$parameter = '';
$isParameter = false;
} elseif($isParameter) {
$parameter .= $character;
} elseif($character === '/') {
$regex .= '\\' . $character;
} else {
$regex .= $character;
}
$lastCharacter = $character;
}
$parameterValues = array();
if(preg_match('/^'.$regex.'$/is', $url, $parameterValues)) {
$parameters = array();
if(count($parameterNames)) {
foreach($parameterNames as $name) {
$parameters[$name] = isset($parameterValues[$name]) ? $parameterValues[$name] : null;
}
}
$this->parameters = $parameters;
return $this;
}
return null;
}
@@ -126,7 +121,11 @@ class RouterRoute extends RouterEntry {
*/
public function setUrl($url) {
$parameters = $this->parseParameters($url, true);
$parameters = array();
preg_match_all('/'.self::PARAMETERS_REGEX_MATCH.'/is', $url, $parameters);
$parameters = $parameters[1];
if($parameters !== null) {
foreach($parameters as $param) {
+1 -1
View File
@@ -4,7 +4,7 @@
* ---------------------------
* Router helper class
* ---------------------------
* This class is added so calls can be made staticly like Router::get() making the code look more pretty.
* This class is added so calls can be made statically like Router::get() making the code look more pretty.
*/
namespace Pecee\SimpleRouter;