Compare commits

..

5 Commits

Author SHA1 Message Date
Simon Sessingø 0aea8673d9 Merge pull request #632 from skipperbent/v5-development
Version 5.0.0.3
2023-02-13 14:06:24 +01:00
Simon Sessingø 9c66a4dfd8 Merge pull request #630 from skipperbent/v5-development
Version 5.0.0.2
2023-02-11 17:34:48 +01:00
Simon Sessingø d5bf77cbd4 Merge pull request #628 from skipperbent/v5-development
Fixed offsetGet return type deprication warning
2023-02-09 03:34:48 +01:00
Simon Sessingø 1e9fa9c6a1 Merge pull request #627 from skipperbent/v4-development
Version 5.0.0.0
2023-02-09 03:07:54 +01:00
Simon Sessingø 0630569f56 Merge pull request #592 from skipperbent/master
fixed json_encode 2nd parameter int flag issue in response and issue with offsetGet return type incompatibility
2023-02-09 02:30:02 +01:00
33 changed files with 228 additions and 418 deletions
+1 -2
View File
@@ -1,5 +1,4 @@
composer.lock
vendor/
.idea/
.phpunit.result.cache
tests/tmp
.phpunit.result.cache
+9 -44
View File
@@ -36,12 +36,11 @@ You can donate any amount of your choice by [clicking here](https://www.paypal.c
- [Available methods](#available-methods)
- [Multiple HTTP-verbs](#multiple-http-verbs)
- [Route parameters](#route-parameters)
- [Required parameters](#required-parameters)
- [Optional parameters](#optional-parameters)
- [Including slash in parameters](#including-slash-in-parameters)
- [Regular expression constraints](#regular-expression-constraints)
- [Regular expression route-match](#regular-expression-route-match)
- [Custom regex for matching parameters](#custom-regex-for-matching-parameters)
- [Required parameters](#required-parameters)
- [Optional parameters](#optional-parameters)
- [Regular expression constraints](#regular-expression-constraints)
- [Regular expression route-match](#regular-expression-route-match)
- [Custom regex for matching parameters](#custom-regex-for-matching-parameters)
- [Named routes](#named-routes)
- [Generating URLs To Named Routes](#generating-urls-to-named-routes)
- [Router groups](#router-groups)
@@ -85,7 +84,7 @@ You can donate any amount of your choice by [clicking here](https://www.paypal.c
- [Registering new event](#registering-new-event)
- [Custom EventHandlers](#custom-eventhandlers)
- [Advanced](#advanced)
- [Multiple route rendering](#multiple-route-rendering)
- [Disable multiple route rendering](#disable-multiple-route-rendering)
- [Restrict access to IP](#restrict-access-to-ip)
- [Setting custom base path](#setting-custom-base-path)
- [Url rewriting](#url-rewriting)
@@ -491,28 +490,6 @@ SimpleRouter::get('/user/{name?}', function ($name = 'Simon') {
});
```
### Including slash in parameters
If you're working with WebDAV services the url could mean the difference between a file and a folder.
For instance `/path` will be considered a file - whereas `/path/` will be considered a folder.
The router can add the ending slash for the last parameter in your route based on the path. So if `/path/` is requested the parameter will contain the value of `path/` and visa versa.
To ensure compatibility with older versions, this feature is disabled by default and has to be enabled by setting
the `setSettings(['includeSlash' => true])` or by using setting `setSlashParameterEnabled(true)` for your route.
**Example**
```php
SimpleRouter::get('/path/{fileOrFolder}', function ($fileOrFolder) {
return $fileOrFolder;
})->setSettings(['includeSlash' => true]);
```
- Requesting `/path/file` will return the `$fileOrFolder` value: `file`.
- Requesting `/path/folder/` will return the `$fileOrFolder` value: `folder/`.
### Regular expression constraints
You may constrain the format of your route parameters using the where method on a route instance. The where method accepts the name of the parameter and a regular expression defining how the parameter should be constrained:
@@ -1036,17 +1013,6 @@ class CustomExceptionHandler implements IExceptionHandler
return;
}
/* Other error */
if($error instanceof MyCustomException) {
$request->setRewriteRoute(
// Add new route based on current url (minus query-string) and add custom parameters.
(new RouteUrl(url(null, null, []), 'PageController@error'))->setParameters(['exception' => $error])
);
return;
}
throw $error;
@@ -1503,12 +1469,11 @@ class DatabaseDebugHandler implements IEventHandler
# Advanced
## Multiple route rendering
## Disable multiple route rendering
If you need multiple routes to be executed on the same url, you can enable this feature by setting `SimpleRouter::enableMultiRouteRendering(true)`
in your `routes.php` file.
By default the router will try to execute all routes that matches a given url. To stop the router from executing any further routes any method can return a value.
This is most commonly used in advanced cases, for example in CMS systems where multiple routes needs to be rendered.
This behavior can be easily disabled by setting `SimpleRouter::enableMultiRouteRendering(false)` in your `routes.php` file. This is the same behavior as version 3 and below.
## Restrict access to IP
+11 -11
View File
@@ -9,37 +9,37 @@ class InputFile implements IInputItem
/**
* @var string
*/
public string $index;
public $index;
/**
* @var string
*/
public string $name;
public $name;
/**
* @var string|null
*/
public ?string $filename = null;
public $filename;
/**
* @var int|null
*/
public ?int $size = null;
public $size;
/**
* @var string|null
* @var int|null
*/
public ?string $type = null;
public $type;
/**
* @var int
*/
public int $errors = 0;
public $errors;
/**
* @var string|null
*/
public ?string $tmpName = null;
public $tmpName;
public function __construct(string $index)
{
@@ -74,7 +74,7 @@ class InputFile implements IInputItem
'error' => null,
];
return (new self($values['index']))
return (new static($values['index']))
->setSize((int)$values['size'])
->setError((int)$values['error'])
->setType($values['type'])
@@ -104,9 +104,9 @@ class InputFile implements IInputItem
}
/**
* @return int
* @return string
*/
public function getSize(): ?int
public function getSize(): string
{
return $this->size;
}
+7 -7
View File
@@ -10,40 +10,40 @@ class InputHandler
/**
* @var array
*/
protected array $get = [];
protected $get = [];
/**
* @var array
*/
protected array $post = [];
protected $post = [];
/**
* @var array
*/
protected array $file = [];
protected $file = [];
/**
* @var Request
*/
protected Request $request;
protected $request;
/**
* Original post variables
* @var array
*/
protected array $originalPost = [];
protected $originalPost = [];
/**
* Original get/params variables
* @var array
*/
protected array $originalParams = [];
protected $originalParams = [];
/**
* Get original file variables
* @var array
*/
protected array $originalFile = [];
protected $originalFile = [];
/**
* Input constructor.
+2 -11
View File
@@ -8,18 +8,10 @@ use IteratorAggregate;
class InputItem implements ArrayAccess, IInputItem, IteratorAggregate
{
public string $index;
public string $name;
/**
* @var mixed|null
*/
public $index;
public $name;
public $value;
/**
* @param string $index
* @param mixed $value
*/
public function __construct(string $index, $value = null)
{
$this->index = $index;
@@ -89,7 +81,6 @@ class InputItem implements ArrayAccess, IInputItem, IteratorAggregate
return isset($this->value[$offset]);
}
#[\ReturnTypeWillChange]
public function offsetGet($offset): ?self
{
if ($this->offsetExists($offset) === true) {
+20 -25
View File
@@ -17,18 +17,18 @@ class BaseCsrfVerifier implements IMiddleware
* For example: /admin/*
* @var array|null
*/
protected array $except = [];
protected $except;
/**
* Urls to include. Can be used to include urls from a certain path.
* @var array|null
*/
protected array $include = [];
protected $include;
/**
* @var ITokenProvider
*/
protected ITokenProvider $tokenProvider;
protected $tokenProvider;
/**
* BaseCsrfVerifier constructor.
@@ -38,23 +38,6 @@ class BaseCsrfVerifier implements IMiddleware
$this->tokenProvider = new CookieTokenProvider();
}
protected function isIncluded(Request $request): bool
{
if (count($this->include) > 0) {
foreach ($this->include as $includeUrl) {
$includeUrl = rtrim($includeUrl, '/');
if ($includeUrl[strlen($includeUrl) - 1] === '*') {
$includeUrl = rtrim($includeUrl, '*');
return $request->getUrl()->contains($includeUrl);
}
return ($includeUrl === rtrim($request->getUrl()->getRelativeUrl(false), '/'));
}
}
return false;
}
/**
* Check if the url matches the urls in the except property
* @param Request $request
@@ -62,11 +45,11 @@ class BaseCsrfVerifier implements IMiddleware
*/
protected function skip(Request $request): bool
{
if (count($this->except) === 0) {
if ($this->except === null || count($this->except) === 0) {
return false;
}
foreach ($this->except as $url) {
foreach($this->except as $url) {
$url = rtrim($url, '/');
if ($url[strlen($url) - 1] === '*') {
$url = rtrim($url, '*');
@@ -77,9 +60,20 @@ class BaseCsrfVerifier implements IMiddleware
if ($skip === true) {
$skip = !$this->isIncluded($request);
if(is_array($this->include) === true && count($this->include) > 0) {
foreach($this->include as $includeUrl) {
$includeUrl = rtrim($includeUrl, '/');
if ($includeUrl[strlen($includeUrl) - 1] === '*') {
$includeUrl = rtrim($includeUrl, '*');
$skip = !$request->getUrl()->contains($includeUrl);
break;
}
if ($skip === false) {
$skip = !($includeUrl === rtrim($request->getUrl()->getRelativeUrl(false), '/'));
}
}
if($skip === false) {
continue;
}
@@ -98,11 +92,12 @@ class BaseCsrfVerifier implements IMiddleware
*/
public function handle(Request $request): void
{
if ($this->skip($request) === false && ($request->isPostBack() === true || $this->isIncluded($request) === true)) {
if ($this->skip($request) === false && $request->isPostBack() === true) {
$token = $request->getInputHandler()->value(
static::POST_KEY,
$request->getHeader(static::HEADER_KEY),
Request::$requestTypesPost
);
if ($this->tokenProvider->validate((string)$token) === false) {
@@ -7,8 +7,8 @@ use Pecee\SimpleRouter\Exceptions\HttpException;
abstract class IpRestrictAccess implements IMiddleware
{
protected array $ipBlacklist = [];
protected array $ipWhitelist = [];
protected $ipBlacklist = [];
protected $ipWhitelist = [];
protected function validate(string $ip): bool
{
+17 -19
View File
@@ -29,7 +29,7 @@ class Request
* All request-types
* @var string[]
*/
public static array $requestTypes = [
public static $requestTypes = [
self::REQUEST_TYPE_GET,
self::REQUEST_TYPE_POST,
self::REQUEST_TYPE_PUT,
@@ -43,7 +43,7 @@ class Request
* Post request-types.
* @var string[]
*/
public static array $requestTypesPost = [
public static $requestTypesPost = [
self::REQUEST_TYPE_POST,
self::REQUEST_TYPE_PUT,
self::REQUEST_TYPE_PATCH,
@@ -55,65 +55,65 @@ class Request
*
* @var array
*/
private array $data = [];
private $data = [];
/**
* Server headers
* @var array
*/
protected array $headers = [];
protected $headers = [];
/**
* Request ContentType
* @var string
*/
protected string $contentType;
protected $contentType;
/**
* Request host
* @var string|null
* @var string
*/
protected ?string $host;
protected $host;
/**
* Current request url
* @var Url
*/
protected Url $url;
protected $url;
/**
* Request method
* @var string
*/
protected string $method;
protected $method;
/**
* Input handler
* @var InputHandler
*/
protected InputHandler $inputHandler;
protected $inputHandler;
/**
* Defines if request has pending rewrite
* @var bool
*/
protected bool $hasPendingRewrite = false;
protected $hasPendingRewrite = false;
/**
* @var ILoadableRoute|null
*/
protected ?ILoadableRoute $rewriteRoute = null;
protected $rewriteRoute;
/**
* Rewrite url
* @var string|null
*/
protected ?string $rewriteUrl = null;
protected $rewriteUrl;
/**
* @var array
*/
protected array $loadedRoutes = [];
protected $loadedRoutes = [];
/**
* Request constructor.
@@ -224,17 +224,15 @@ class Request
*/
public function getIp(bool $safeMode = false): ?string
{
$headers = [];
$headers = ['remote-addr'];
if($safeMode === false) {
$headers = [
$headers = array_merge($headers, [
'http-cf-connecting-ip',
'http-client-ip',
'http-x-forwarded-for',
];
]);
}
$headers[] = 'remote-addr';
return $this->getFirstHeader($headers);
}
+2 -1
View File
@@ -7,7 +7,7 @@ use Pecee\Exceptions\InvalidArgumentException;
class Response
{
protected Request $request;
protected $request;
public function __construct(Request $request)
{
@@ -65,6 +65,7 @@ class Response
public function cache(string $eTag, int $lastModifiedTime = 2592000): self
{
$this->headers([
'Cache-Control: public',
sprintf('Last-Modified: %s GMT', gmdate('D, d M Y H:i:s', $lastModifiedTime)),
@@ -12,12 +12,12 @@ class CookieTokenProvider implements ITokenProvider
/**
* @var string
*/
protected ?string $token = null;
protected $token;
/**
* @var int
*/
protected int $cookieTimeoutMinutes = 120;
protected $cookieTimeoutMinutes = 120;
/**
* CookieTokenProvider constructor.
+11 -27
View File
@@ -10,53 +10,47 @@ class Url implements JsonSerializable
/**
* @var string|null
*/
private ?string $originalUrl = null;
private $originalUrl;
/**
* @var string|null
*/
private ?string $scheme = null;
private $scheme;
/**
* @var string|null
*/
private ?string $host = null;
private $host;
/**
* @var int|null
*/
private ?int $port = null;
private $port;
/**
* @var string|null
*/
private ?string $username = null;
private $username;
/**
* @var string|null
*/
private ?string $password = null;
private $password;
/**
* @var string|null
*/
private ?string $path = null;
/**
* Original path with no sanitization to ending slash
* @var string|null
*/
private ?string $originalPath = null;
private $path;
/**
* @var array
*/
private array $params = [];
private $params = [];
/**
* @var string|null
*/
private ?string $fragment = null;
private $fragment;
/**
* Url constructor.
@@ -79,7 +73,6 @@ class Url implements JsonSerializable
if (isset($data['path']) === true) {
$this->setPath($data['path']);
$this->originalPath = $data['path'];
}
$this->fragment = $data['fragment'] ?? null;
@@ -233,15 +226,6 @@ class Url implements JsonSerializable
return $this->path ?? '/';
}
/**
* Get original path with no sanitization of ending trail/slash.
* @return string|null
*/
public function getOriginalPath(): ?string
{
return $this->originalPath;
}
/**
* Set the url path
*
@@ -300,7 +284,7 @@ class Url implements JsonSerializable
$params = [];
parse_str($queryString, $params);
if (count($params) > 0) {
if(count($params) > 0) {
return $this->setParams($params);
}
@@ -485,7 +469,7 @@ class Url implements JsonSerializable
{
$path = $this->path ?? '/';
if ($includeParams === false) {
if($includeParams === false) {
return $path;
}
@@ -27,11 +27,11 @@ class ClassLoader implements IClassLoader
* @param object $class
* @param string $method
* @param array $parameters
* @return string
* @return object
*/
public function loadClassMethod($class, string $method, array $parameters): string
public function loadClassMethod($class, string $method, array $parameters)
{
return (string)call_user_func_array([$class, $method], array_values($parameters));
return call_user_func_array([$class, $method], array_values($parameters));
}
/**
@@ -39,11 +39,11 @@ class ClassLoader implements IClassLoader
*
* @param Callable $closure
* @param array $parameters
* @return string
* @return mixed
*/
public function loadClosure(callable $closure, array $parameters): string
public function loadClosure(Callable $closure, array $parameters)
{
return (string)call_user_func_array($closure, array_values($parameters));
return call_user_func_array($closure, array_values($parameters));
}
}
@@ -17,7 +17,7 @@ interface IClassLoader
* @param object $class
* @param string $method
* @param array $parameters
* @return mixed
* @return object
*/
public function loadClassMethod($class, string $method, array $parameters);
@@ -12,17 +12,17 @@ class EventArgument implements IEventArgument
* Event name
* @var string
*/
protected string $eventName;
protected $eventName;
/**
* @var Router
*/
protected Router $router;
protected $router;
/**
* @var array
*/
protected array $arguments = [];
protected $arguments = [];
public function __construct(string $eventName, Router $router, array $arguments = [])
{
@@ -9,12 +9,12 @@ class ClassNotFoundHttpException extends NotFoundHttpException
/**
* @var string
*/
protected string $class;
protected $class;
/**
* @var string|null
*/
protected ?string $method = null;
protected $method;
public function __construct(string $class, ?string $method = null, string $message = "", int $code = 0, Throwable $previous = null)
{
@@ -20,7 +20,7 @@ class CallbackExceptionHandler implements IExceptionHandler
/**
* @var Closure
*/
protected Closure $callback;
protected $callback;
public function __construct(Closure $callback)
{
@@ -13,7 +13,7 @@ class DebugEventHandler implements IEventHandler
* Debug callback
* @var Closure
*/
protected Closure $callback;
protected $callback;
public function __construct()
{
@@ -97,7 +97,7 @@ class EventHandler implements IEventHandler
* All available events
* @var array
*/
public static array $events = [
public static $events = [
self::EVENT_ALL,
self::EVENT_INIT,
self::EVENT_LOAD,
@@ -120,7 +120,7 @@ class EventHandler implements IEventHandler
* List of all registered events
* @var array
*/
private array $registeredEvents = [];
private $registeredEvents = [];
/**
* Register new event
@@ -12,17 +12,17 @@ abstract class LoadableRoute extends Route implements ILoadableRoute
/**
* @var string
*/
protected string $url;
protected $url;
/**
* @var string
*/
protected ?string $name = null;
protected $name;
/**
* @var string|null
*/
protected ?string $regex = null;
protected $regex;
/**
* Loads and renders middlewares-classes
@@ -82,18 +82,15 @@ abstract class LoadableRoute extends Route implements ILoadableRoute
{
$this->url = ($url === '/') ? '/' : '/' . trim($url, '/') . '/';
$parameters = [];
if (strpos($this->url, $this->paramModifiers[0]) !== false) {
$regex = sprintf(static::PARAMETERS_REGEX_FORMAT, $this->paramModifiers[0], $this->paramOptionalSymbol, $this->paramModifiers[1]);
if ((bool)preg_match_all('/' . $regex . '/u', $this->url, $matches) !== false) {
$parameters = array_fill_keys($matches[1], null);
$this->parameters = array_fill_keys($matches[1], null);
}
}
$this->parameters = $parameters;
return $this;
}
@@ -198,7 +195,7 @@ abstract class LoadableRoute extends Route implements ILoadableRoute
*/
public function hasName(string $name): bool
{
return strtolower((string)$this->name) === strtolower($name);
return strtolower((string)$this->name) === strtolower((string)$name);
}
/**
+20 -55
View File
@@ -18,37 +18,31 @@ abstract class Route implements IRoute
*
* @var bool
*/
protected bool $filterEmptyParams = true;
/**
* If true the last parameter of the route will include ending trail/slash.
* @var bool
*/
protected bool $slashParameterEnabled = false;
protected $filterEmptyParams = true;
/**
* Default regular expression used for parsing parameters.
* @var string|null
*/
protected ?string $defaultParameterRegex = null;
protected string $paramModifiers = '{}';
protected string $paramOptionalSymbol = '?';
protected string $urlRegex = '/^%s\/?$/u';
protected ?IGroupRoute $group = null;
protected ?IRoute $parent = null;
protected $defaultParameterRegex;
protected $paramModifiers = '{}';
protected $paramOptionalSymbol = '?';
protected $urlRegex = '/^%s\/?$/u';
protected $group;
protected $parent;
/**
* @var string|callable|null
*/
protected $callback;
protected ?string $defaultNamespace = null;
protected $defaultNamespace;
/* Default options */
protected ?string $namespace = null;
protected array $requestMethods = [];
protected array $where = [];
protected array $parameters = [];
protected array $originalParameters = [];
protected array $middlewares = [];
protected $namespace;
protected $requestMethods = [];
protected $where = [];
protected $parameters = [];
protected $originalParameters = [];
protected $middlewares = [];
/**
* Render route
@@ -117,7 +111,7 @@ abstract class Route implements IRoute
return $router->getClassLoader()->loadClassMethod($class, $method, $parameters);
}
protected function parseParameters($route, $url, Request $request, $parameterRegex = null): ?array
protected function parseParameters($route, $url, $parameterRegex = null): ?array
{
$regex = (strpos($route, $this->paramModifiers[0]) === false) ? null :
sprintf
@@ -129,10 +123,8 @@ abstract class Route implements IRoute
);
// Ensures that host names/domains will work with parameters
if ($route[0] === $this->paramModifiers[0]) {
$url = '/' . ltrim($url, '/');
}
if($route[0] == '{') $url = '/' . ltrim($url, '/');
$urlRegex = '';
$parameters = [];
@@ -140,7 +132,7 @@ abstract class Route implements IRoute
$urlRegex = preg_quote($route, '/');
} else {
foreach (preg_split('/((\.?-?\/?){[^' . $this->paramModifiers[1] . ']+' . $this->paramModifiers[1] . ')/', $route) as $key => $t) {
foreach (preg_split('/((\.?-?\/?){[^}]+})/', $route) as $key => $t) {
$regex = '';
@@ -162,7 +154,6 @@ abstract class Route implements IRoute
}
}
// Get name of last param
if (trim($urlRegex) === '' || (bool)preg_match(sprintf($this->urlRegex, $urlRegex), $url, $matches) === false) {
return null;
}
@@ -176,8 +167,7 @@ abstract class Route implements IRoute
$lastParams = [];
/* Only take matched parameters with name */
$originalPath = $request->getUrl()->getOriginalPath();
foreach ((array)$parameters[1] as $i => $name) {
foreach ((array)$parameters[1] as $name) {
// Ignore parent parameters
if (isset($groupParameters[$name]) === true) {
@@ -185,16 +175,10 @@ abstract class Route implements IRoute
continue;
}
// If last parameter and slash parameter is enabled, use slash according to original path (non sanitized version)
$lastParameter = $this->paramModifiers[0] . $name . $this->paramModifiers[1] . '/';
if ($this->slashParameterEnabled && ($i === count($parameters[1]) - 1) && (substr_compare($route, $lastParameter, -strlen($lastParameter)) === 0) && $originalPath[strlen($originalPath) - 1] === '/') {
$matches[$name] .= '/';
}
$values[$name] = (isset($matches[$name]) === true && $matches[$name] !== '') ? $matches[$name] : null;
}
$values += $lastParams;
$values = array_merge($values, $lastParams);
}
$this->originalParameters = $values;
@@ -403,17 +387,6 @@ abstract class Route implements IRoute
return $this->namespace ?? $this->defaultNamespace;
}
public function setSlashParameterEnabled(bool $enabled): self
{
$this->slashParameterEnabled = $enabled;
return $this;
}
public function getSlashParameterEnabled(): bool
{
return $this->slashParameterEnabled;
}
/**
* Export route settings to array so they can be merged with another route.
*
@@ -443,10 +416,6 @@ abstract class Route implements IRoute
$values['defaultParameterRegex'] = $this->defaultParameterRegex;
}
if ($this->slashParameterEnabled === true) {
$values['includeSlash'] = $this->slashParameterEnabled;
}
return $values;
}
@@ -484,10 +453,6 @@ abstract class Route implements IRoute
$this->setDefaultParameterRegex($settings['defaultParameterRegex']);
}
if (isset($settings['includeSlash']) === true) {
$this->setSlashParameterEnabled($settings['includeSlash']);
}
return $this;
}
@@ -6,10 +6,10 @@ use Pecee\Http\Request;
class RouteController extends LoadableRoute implements IControllerRoute
{
protected string $defaultMethod = 'index';
protected string $controller;
protected ?string $method = null;
protected array $names = [];
protected $defaultMethod = 'index';
protected $controller;
protected $method;
protected $names = [];
public function __construct($url, $controller)
{
+9 -9
View File
@@ -7,12 +7,12 @@ use Pecee\SimpleRouter\Handlers\IExceptionHandler;
class RouteGroup extends Route implements IGroupRoute
{
protected string $urlRegex = '/^%s\/?/u';
protected ?string $prefix = null;
protected ?string $name = null;
protected array $domains = [];
protected array $exceptionHandlers = [];
protected bool $mergeExceptionHandlers = true;
protected $urlRegex = '/^%s\/?/u';
protected $prefix;
protected $name;
protected $domains = [];
protected $exceptionHandlers = [];
protected $mergeExceptionHandlers = true;
/**
* Method called to check if a domain matches
@@ -22,7 +22,7 @@ class RouteGroup extends Route implements IGroupRoute
*/
public function matchDomain(Request $request): bool
{
if (count($this->domains) === 0) {
if ($this->domains === null || count($this->domains) === 0) {
return true;
}
@@ -33,7 +33,7 @@ class RouteGroup extends Route implements IGroupRoute
return true;
}
$parameters = $this->parseParameters($domain, $request->getHost(), $request, '.*');
$parameters = $this->parseParameters($domain, $request->getHost(), '.*');
if ($parameters !== null && count($parameters) !== 0) {
$this->parameters = $parameters;
@@ -60,7 +60,7 @@ class RouteGroup extends Route implements IGroupRoute
if ($this->prefix !== null) {
/* Parse parameters from current route */
$parameters = $this->parseParameters($this->prefix, $url, $request);
$parameters = $this->parseParameters($this->prefix, $url);
/* If no custom regular expression or parameters was found on this route, we stop */
if ($parameters === null) {
+25 -32
View File
@@ -6,28 +6,28 @@ use Pecee\Http\Request;
class RouteResource extends LoadableRoute implements IControllerRoute
{
protected array $urls = [
'index' => '',
'create' => 'create',
'store' => '',
'show' => '',
'edit' => 'edit',
'update' => '',
protected $urls = [
'index' => '',
'create' => 'create',
'store' => '',
'show' => '',
'edit' => 'edit',
'update' => '',
'destroy' => '',
];
protected array $methodNames = [
'index' => 'index',
'create' => 'create',
'store' => 'store',
'show' => 'show',
'edit' => 'edit',
'update' => 'update',
protected $methodNames = [
'index' => 'index',
'create' => 'create',
'store' => 'store',
'show' => 'show',
'edit' => 'edit',
'update' => 'update',
'destroy' => 'destroy',
];
protected array $names = [];
protected string $controller;
protected $names = [];
protected $controller;
public function __construct($url, $controller)
{
@@ -69,18 +69,11 @@ class RouteResource extends LoadableRoute implements IControllerRoute
public function findUrl(?string $method = null, $parameters = null, ?string $name = null): string
{
$url = array_search($name, $this->names, true);
$parametersUrl = '';
if ($parameters !== null && count($parameters) > 0) {
$parametersUrl = join('/', $parameters) . '/';
}
if ($url !== false) {
return rtrim($this->url . $parametersUrl . $this->urls[$url], '/') . '/';
return rtrim($this->url . $this->urls[$url], '/') . '/';
}
return $this->url . $parametersUrl;
return $this->url;
}
protected function call($method): bool
@@ -106,7 +99,7 @@ class RouteResource extends LoadableRoute implements IControllerRoute
$route = rtrim($this->url, '/') . '/{id?}/{action?}';
/* Parse parameters from current route */
$this->parameters = $this->parseParameters($route, $url, $request);
$this->parameters = $this->parseParameters($route, $url);
/* If no custom regular expression or parameters was found on this route, we stop */
if ($regexMatch === null && $this->parameters === null) {
@@ -179,12 +172,12 @@ class RouteResource extends LoadableRoute implements IControllerRoute
$this->name = $name;
$this->names = [
'index' => $this->name . '.index',
'create' => $this->name . '.create',
'store' => $this->name . '.store',
'show' => $this->name . '.show',
'edit' => $this->name . '.edit',
'update' => $this->name . '.update',
'index' => $this->name . '.index',
'create' => $this->name . '.create',
'store' => $this->name . '.store',
'show' => $this->name . '.show',
'edit' => $this->name . '.edit',
'update' => $this->name . '.update',
'destroy' => $this->name . '.destroy',
];
+1 -1
View File
@@ -31,7 +31,7 @@ class RouteUrl extends LoadableRoute
}
/* Parse parameters from current route */
$parameters = $this->parseParameters($this->url, $url, $request);
$parameters = $this->parseParameters($this->url, $url);
/* If no custom regular expression or parameters was found on this route, we stop */
if ($regexMatch === null && $parameters === null) {
+36 -36
View File
@@ -28,56 +28,56 @@ class Router
* Current request
* @var Request
*/
protected Request $request;
protected $request;
/**
* Defines if a route is currently being processed.
* @var bool
*/
protected bool $isProcessingRoute;
protected $isProcessingRoute;
/**
* Defines all data from current processing route.
* @var ILoadableRoute
*/
protected ILoadableRoute $currentProcessingRoute;
protected $currentProcessingRoute;
/**
* All added routes
* @var array
*/
protected array $routes = [];
protected $routes = [];
/**
* List of processed routes
* @var array|ILoadableRoute[]
*/
protected array $processedRoutes = [];
protected $processedRoutes = [];
/**
* Stack of routes used to keep track of sub-routes added
* when a route is being processed.
* @var array
*/
protected array $routeStack = [];
protected $routeStack = [];
/**
* List of added bootmanagers
* @var array
*/
protected array $bootManagers = [];
protected $bootManagers = [];
/**
* Csrf verifier class
* @var BaseCsrfVerifier|null
*/
protected ?BaseCsrfVerifier $csrfVerifier;
protected $csrfVerifier;
/**
* Get exception handlers
* @var array
*/
protected array $exceptionHandlers = [];
protected $exceptionHandlers = [];
/**
* List of loaded exception that has been loaded.
@@ -85,44 +85,44 @@ class Router
*
* @var array
*/
protected array $loadedExceptionHandlers = [];
protected $loadedExceptionHandlers = [];
/**
* Enable or disabled debugging
* @var bool
*/
protected bool $debugEnabled = false;
protected $debugEnabled = false;
/**
* The start time used when debugging is enabled
* @var float
*/
protected float $debugStartTime;
protected $debugStartTime;
/**
* List containing all debug messages
* @var array
*/
protected array $debugList = [];
protected $debugList = [];
/**
* Contains any registered event-handler.
* @var array
*/
protected array $eventHandlers = [];
protected $eventHandlers = [];
/**
* Class loader instance
* @var IClassLoader
*/
protected IClassLoader $classLoader;
protected $classLoader;
/**
* When enabled the router will render all routes that matches.
* When disabled the router will stop execution when first route is found.
* @var bool
*/
protected bool $renderMultipleRoutes = false;
protected $renderMultipleRoutes = true;
/**
* Router constructor.
@@ -166,7 +166,7 @@ class Router
public function addRoute(IRoute $route): IRoute
{
$this->fireEvents(EventHandler::EVENT_ADD_ROUTE, [
'route' => $route,
'route' => $route,
'isSubRoute' => $this->isProcessingRoute,
]);
@@ -307,7 +307,7 @@ class Router
$this->debug('Rendering bootmanager "%s"', $className);
$this->fireEvents(EventHandler::EVENT_RENDER_BOOTMANAGER, [
'bootmanagers' => $this->bootManagers,
'bootmanager' => $manager,
'bootmanager' => $manager,
]);
/* Render bootmanager */
@@ -345,8 +345,8 @@ class Router
try {
/* Verify csrf token for request */
$this->csrfVerifier->handle($this->request);
} catch (Exception $e) {
return $this->handleException($e);
} catch(\Exception $e) {
$this->handleException($e);
}
}
@@ -381,7 +381,7 @@ class Router
foreach ($this->processedRoutes as $key => $route) {
$this->debug('Matching route "%s"', get_class($route));
/* Add current processing route to constants */
$this->currentProcessingRoute = $route;
@@ -405,7 +405,7 @@ class Router
}
$this->fireEvents(EventHandler::EVENT_RENDER_MIDDLEWARES, [
'route' => $route,
'route' => $route,
'middlewares' => $route->getMiddlewares(),
]);
@@ -427,7 +427,7 @@ class Router
$routeOutput = $route->renderRoute($this->request, $this);
if ($this->renderMultipleRoutes === true) {
if ($routeOutput !== '') {
if ($routeOutput !== null) {
return $routeOutput;
}
@@ -444,12 +444,12 @@ class Router
}
} catch (Exception $e) {
return $this->handleException($e);
$this->handleException($e);
}
if ($methodNotAllowed === true) {
$message = sprintf('Route "%s" or method "%s" not allowed.', $this->request->getUrl()->getPath(), $this->request->getMethod());
return $this->handleException(new NotFoundHttpException($message, 403));
$this->handleException(new NotFoundHttpException($message, 403));
}
if (count($this->request->getLoadedRoutes()) === 0) {
@@ -500,7 +500,7 @@ class Router
$this->request->setHasPendingRewrite(false);
$this->fireEvents(EventHandler::EVENT_REWRITE, [
'rewriteUrl' => $this->request->getRewriteUrl(),
'rewriteUrl' => $this->request->getRewriteUrl(),
'rewriteRoute' => $this->request->getRewriteRoute(),
]);
@@ -521,7 +521,7 @@ class Router
$this->debug('Starting exception handling for "%s"', get_class($e));
$this->fireEvents(EventHandler::EVENT_LOAD_EXCEPTIONS, [
'exception' => $e,
'exception' => $e,
'exceptionHandlers' => $this->exceptionHandlers,
]);
@@ -533,8 +533,8 @@ class Router
}
$this->fireEvents(EventHandler::EVENT_RENDER_EXCEPTION, [
'exception' => $e,
'exceptionHandler' => $handler,
'exception' => $e,
'exceptionHandler' => $handler,
'exceptionHandlers' => $this->exceptionHandlers,
]);
@@ -556,7 +556,7 @@ class Router
$this->debug('Exception handler contains rewrite, reloading routes');
$this->fireEvents(EventHandler::EVENT_REWRITE, [
'rewriteUrl' => $this->request->getRewriteUrl(),
'rewriteUrl' => $this->request->getRewriteUrl(),
'rewriteRoute' => $this->request->getRewriteRoute(),
]);
@@ -667,9 +667,9 @@ class Router
$this->debug('Finding url', func_get_args());
$this->fireEvents(EventHandler::EVENT_GET_URL, [
'name' => $name,
'name' => $name,
'parameters' => $parameters,
'getParams' => $getParams,
'getParams' => $getParams,
]);
if ($name === '' && $parameters === '') {
@@ -913,8 +913,8 @@ class Router
$trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2);
$this->debugList[] = [
'message' => vsprintf($message, $args),
'time' => number_format(microtime(true) - $this->debugStartTime, 10),
'trace' => end($trace),
'time' => number_format(microtime(true) - $this->debugStartTime, 10),
'trace' => end($trace),
];
}
@@ -940,7 +940,7 @@ class Router
{
return $this->debugList;
}
/**
* Get the current processing route details.
*
+5 -5
View File
@@ -37,19 +37,19 @@ class SimpleRouter
* Default namespace added to all routes
* @var string|null
*/
protected static ?string $defaultNamespace = null;
protected static $defaultNamespace;
/**
* The response object
* @var Response|null
* @var Response
*/
protected static ?Response $response = null;
protected static $response;
/**
* Router instance
* @var Router
*/
protected static ?Router $router = null;
protected static $router;
/**
* Start routing
@@ -493,7 +493,7 @@ class SimpleRouter
* Prepends the default namespace to all new routes added.
*
* @param ILoadableRoute|IRoute $route
* @return IRoute|ILoadableRoute
* @return IRoute
*/
public static function addDefaultNamespace(IRoute $route): IRoute
{
@@ -2,12 +2,12 @@
class DummyCsrfVerifier extends \Pecee\Http\Middleware\BaseCsrfVerifier {
protected array $except = [
protected $except = [
'/exclude-page',
'/exclude-all/*',
];
protected array $include = [
protected $include = [
'/exclude-all/include-page',
];
@@ -2,12 +2,12 @@
class IpRestrictMiddleware extends \Pecee\Http\Middleware\IpRestrictAccess {
protected array $ipBlacklist = [
protected $ipBlacklist = [
'5.5.5.5',
'8.8.*',
];
protected array $ipWhitelist = [
protected $ipWhitelist = [
'8.8.2.2',
];
@@ -1,11 +0,0 @@
<?php
use Pecee\Http\Request;
class DummyLoadableRoute extends Pecee\SimpleRouter\Route\LoadableRoute {
public function matchRoute(string $url, Request $request): bool
{
return false;
}
}
@@ -1,27 +0,0 @@
<?php
require_once 'Dummy/Route/DummyLoadableRoute.php';
class LoadableRouteTest extends \PHPUnit\Framework\TestCase
{
public function testSetUrlUpdatesParameters()
{
$route = new DummyLoadableRoute();
$this->assertEmpty($route->getParameters());
$route->setUrl('/');
$this->assertEmpty($route->getParameters());
$expected = ['param' => null, 'optionalParam' => null];
$route->setUrl('/{param}/{optionalParam?}');
$this->assertEquals($expected, $route->getParameters());
$expected = ['otherParam' => null];
$route->setUrl('/{otherParam}');
$this->assertEquals($expected, $route->getParameters());
$expected = [];
$route->setUrl('/');
$this->assertEquals($expected, $route->getParameters());
}
}
@@ -63,22 +63,7 @@ class RouterResourceTest extends \PHPUnit\Framework\TestCase
$response = TestRouter::debugOutput('/resource/38', 'get');
$this->assertEquals('show 38', $response);
}
public function testResourceUrls()
{
TestRouter::resource('/resource', 'ResourceController')->name('resource');
TestRouter::debugNoReset('/resource');
$this->assertEquals('/resource/3/create/', TestRouter::router()->getUrl('resource.create', ['id' => 3]));
$this->assertEquals('/resource/5/edit/', TestRouter::router()->getUrl('resource.edit', ['id' => 5]));
$this->assertEquals('/resource/6/', TestRouter::router()->getUrl('resource.update', ['id' => 6]));
$this->assertEquals('/resource/9/', TestRouter::router()->getUrl('resource.destroy', ['id' => 9]));
$this->assertEquals('/resource/12/', TestRouter::router()->getUrl('resource.delete', ['id' => 12]));
$this->assertEquals('/resource/', TestRouter::router()->getUrl('resource'));
TestRouter::router()->reset();
}
}
+19 -39
View File
@@ -27,23 +27,6 @@ class RouterUrlTest extends \PHPUnit\Framework\TestCase
TestRouter::router()->reset();
}
public function testLastParameterSlash()
{
TestRouter::get('/test/{param}', function ($param) {
return $param;
})->setSettings(['includeSlash' => true]);
// Test with ending /
$output = TestRouter::debugOutputNoReset('/test/param/');
$this->assertEquals($output, 'param/');
// Test without ending /
$output = TestRouter::debugOutputNoReset('/test/param');
$this->assertEquals($output, 'param');
TestRouter::router()->reset();
}
public function testUnicodeCharacters()
{
// Test spanish characters
@@ -184,7 +167,7 @@ class RouterUrlTest extends \PHPUnit\Framework\TestCase
// Should match /?jackdaniels=true&cola=yeah
$this->assertEquals('/?jackdaniels=true&cola=yeah', TestRouter::getUrl('home', null, ['jackdaniels' => 'true', 'cola' => 'yeah']));
TestRouter::reset();
TestRouter::router()->reset();
}
@@ -208,7 +191,7 @@ class RouterUrlTest extends \PHPUnit\Framework\TestCase
$results = '';
TestRouter::get('/tester/{param}', function ($param = null) use ($results) {
TestRouter::get('/tester/{param}', function ($param = null) use($results) {
return $results = $param;
})->setMatch('/(.*)/i');
@@ -251,9 +234,9 @@ class RouterUrlTest extends \PHPUnit\Framework\TestCase
TestRouter::debug('/');
$this->assertCount(2, $result);
$this->assertCount(2, $result);
}
public function testDefaultNamespace()
{
TestRouter::setDefaultNamespace('\\Default\\Namespace');
@@ -262,14 +245,14 @@ class RouterUrlTest extends \PHPUnit\Framework\TestCase
TestRouter::group([
'namespace' => 'Appended\Namespace',
'prefix' => '/horses',
'prefix' => '/horses',
], function () {
TestRouter::get('/', 'DummyController@method1');
TestRouter::group([
'namespace' => '\\New\\Namespace',
'prefix' => '/race',
'prefix' => '/race',
], function () {
TestRouter::get('/', 'DummyController@method1');
@@ -304,14 +287,13 @@ class RouterUrlTest extends \PHPUnit\Framework\TestCase
TestRouter::router()->reset();
}
public function testGroupPrefix()
{
public function testGroupPrefix() {
$result = false;
TestRouter::group(['prefix' => '/lang/{lang}'], function () use (&$result) {
TestRouter::group(['prefix' => '/lang/{lang}'], function () use(&$result) {
TestRouter::get('/test', function () use (&$result) {
TestRouter::get('/test', function() use(&$result) {
$result = true;
});
});
@@ -325,13 +307,13 @@ class RouterUrlTest extends \PHPUnit\Framework\TestCase
$result = null;
$expectedResult = 28;
TestRouter::group(['prefix' => '/lang/{lang}'], function () use (&$result) {
TestRouter::group(['prefix' => '/lang/{lang}'], function () use(&$result) {
TestRouter::get('/horse/{horseType}', function ($horseType) use (&$result) {
TestRouter::get('/horse/{horseType}', function($horseType) use(&$result) {
$result = false;
});
TestRouter::get('/user/{userId}', function ($userId) use (&$result) {
TestRouter::get('/user/{userId}', function($userId) use(&$result) {
$result = $userId;
});
});
@@ -342,15 +324,14 @@ class RouterUrlTest extends \PHPUnit\Framework\TestCase
}
public function testPassParameter()
{
public function testPassParameter() {
$result = false;
$expectedLanguage = 'da';
TestRouter::group(['prefix' => '/lang/{lang}'], function ($language) use (&$result) {
TestRouter::group(['prefix' => '/lang/{lang}'], function ($language) use(&$result) {
TestRouter::get('/test', function ($language) use (&$result) {
TestRouter::get('/test', function($language) use(&$result) {
$result = $language;
});
@@ -362,16 +343,15 @@ class RouterUrlTest extends \PHPUnit\Framework\TestCase
}
public function testPassParameterDeep()
{
public function testPassParameterDeep() {
$result = false;
$expectedLanguage = 'da';
TestRouter::group(['prefix' => '/lang/{lang}'], function ($language) use (&$result) {
TestRouter::group(['prefix' => '/lang/{lang}'], function ($language) use(&$result) {
TestRouter::group(['prefix' => '/admin'], function ($language) use (&$result) {
TestRouter::get('/test', function ($language) use (&$result) {
TestRouter::group(['prefix' => '/admin'], function($language) use(&$result) {
TestRouter::get('/test', function($language) use(&$result) {
$result = $language;
});
});
-5
View File
@@ -8,11 +8,6 @@ class TestRouter extends \Pecee\SimpleRouter\SimpleRouter
static::request()->setHost('testhost.com');
}
public static function reset(): void
{
static::$router = null;
}
public static function debugNoReset(string $testUrl, string $testMethod = 'get'): void
{
$request = static::request();