geckon01/simple-php-router
1
0
Fork 0
mirror of https://github.com/skipperbent/simple-php-router.git synced 2026-07-11 04:22:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

[CLEANUP] Cleaned up code

Browse Source 
- Change variable $values to $settings in Route::setSettings method.
- Added return types to methods.
- Added type to method variables.
- Change ClassNotFoundException so required parameters are first.
This commit is contained in:
Simon Sessingø
2021-03-29 00:00:01 +02:00
parent 9ed2d2b8d1
commit c916a1dd2e
16 changed files with 72 additions and 72 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/Pecee/SimpleRouter/Route/IGroupRoute.php
+1 -1
View File
@@ -29,7 +29,7 @@ interface IGroupRoute extends IRoute
* @param array $handlers
* @return static
*/
public function setExceptionHandlers(array $handlers);
public function setExceptionHandlers(array $handlers): self;
/**
* Get exception-handlers for group
src/Pecee/SimpleRouter/Route/ILoadableRoute.php
+1 -1
View File
@@ -82,6 +82,6 @@ interface ILoadableRoute extends IRoute
* @param string $regex
* @return static
*/
public function setMatch($regex): self;
public function setMatch(string $regex): self;
}
src/Pecee/SimpleRouter/Route/IRoute.php
+4 -4
View File
@@ -10,11 +10,11 @@ interface IRoute
/**
* Method called to check if a domain matches
*
* @param string $route
* @param string $url
* @param Request $request
* @return bool
*/
public function matchRoute($route, Request $request): bool;
public function matchRoute(string $url, Request $request): bool;
/**
* Called when route is matched.
@@ -129,7 +129,7 @@ interface IRoute
* @param string $namespace
* @return static
*/
public function setDefaultNamespace($namespace): IRoute;
public function setDefaultNamespace(string $namespace): IRoute;
/**
* Get default namespace
@@ -196,7 +196,7 @@ interface IRoute
* @param string $middleware
* @return static
*/
public function addMiddleware($middleware): self;
public function addMiddleware(string $middleware): self;
/**
* Set middlewares array
src/Pecee/SimpleRouter/Route/LoadableRoute.php
+8 -8
View File
@@ -183,7 +183,7 @@ abstract class LoadableRoute extends Route implements ILoadableRoute
* @param string $regex
* @return static
*/
public function setMatch($regex): ILoadableRoute
public function setMatch(string $regex): ILoadableRoute
{
$this->regex = $regex;
@@ -229,15 +229,15 @@ abstract class LoadableRoute extends Route implements ILoadableRoute
/**
* Merge with information from another route.
*
* @param array $values
* @param array $settings
* @param bool $merge
* @return static
*/
public function setSettings(array $values, bool $merge = false): IRoute
public function setSettings(array $settings, bool $merge = false): IRoute
{
if (isset($values['as']) === true) {
if (isset($settings['as']) === true) {
$name = $values['as'];
$name = $settings['as'];
if ($this->name !== null && $merge !== false) {
$name .= '.' . $this->name;
@@ -246,11 +246,11 @@ abstract class LoadableRoute extends Route implements ILoadableRoute
$this->setName($name);
}
if (isset($values['prefix']) === true) {
$this->prependUrl($values['prefix']);
if (isset($settings['prefix']) === true) {
$this->prependUrl($settings['prefix']);
}
return parent::setSettings($values, $merge);
return parent::setSettings($settings, $merge);
}
}
src/Pecee/SimpleRouter/Route/Route.php
+21 -21
View File
@@ -95,7 +95,7 @@ abstract class Route implements IRoute
}
if (method_exists($class, $method) === false) {
throw new ClassNotFoundHttpException(sprintf('Method "%s" does not exist in class "%s"', $method, $className), 404, null, $className, $method);
throw new ClassNotFoundHttpException($className, $method, sprintf('Method "%s" does not exist in class "%s"', $method, $className), 404, null);
}
$router->debug('Executing callback');
@@ -327,7 +327,7 @@ abstract class Route implements IRoute
* @param string $namespace
* @return static
*/
public function setDefaultNamespace($namespace): IRoute
public function setDefaultNamespace(string $namespace): IRoute
{
$this->defaultNamespace = $namespace;
@@ -382,35 +382,35 @@ abstract class Route implements IRoute
/**
* Merge with information from another route.
*
* @param array $values
* @param array $settings
* @param bool $merge
* @return static
*/
public function setSettings(array $values, bool $merge = false): IRoute
public function setSettings(array $settings, bool $merge = false): IRoute
{
if ($this->namespace === null && isset($values['namespace']) === true) {
$this->setNamespace($values['namespace']);
if ($this->namespace === null && isset($settings['namespace']) === true) {
$this->setNamespace($settings['namespace']);
}
if (isset($values['method']) === true) {
$this->setRequestMethods(array_merge($this->requestMethods, (array)$values['method']));
if (isset($settings['method']) === true) {
$this->setRequestMethods(array_merge($this->requestMethods, (array)$settings['method']));
}
if (isset($values['where']) === true) {
$this->setWhere(array_merge($this->where, (array)$values['where']));
if (isset($settings['where']) === true) {
$this->setWhere(array_merge($this->where, (array)$settings['where']));
}
if (isset($values['parameters']) === true) {
$this->setParameters(array_merge($this->parameters, (array)$values['parameters']));
if (isset($settings['parameters']) === true) {
$this->setParameters(array_merge($this->parameters, (array)$settings['parameters']));
}
// Push middleware if multiple
if (isset($values['middleware']) === true) {
$this->setMiddlewares(array_merge((array)$values['middleware'], $this->middlewares));
if (isset($settings['middleware']) === true) {
$this->setMiddlewares(array_merge((array)$settings['middleware'], $this->middlewares));
}
if (isset($values['defaultParameterRegex']) === true) {
$this->setDefaultParameterRegex($values['defaultParameterRegex']);
if (isset($settings['defaultParameterRegex']) === true) {
$this->setDefaultParameterRegex($settings['defaultParameterRegex']);
}
return $this;
@@ -493,11 +493,11 @@ abstract class Route implements IRoute
/**
* Add middleware class-name
*
* @param IMiddleware|string $middleware
* @param string $middleware
* @return static
* @deprecated This method is deprecated and will be removed in the near future.
*/
public function setMiddleware($middleware)
public function setMiddleware(string $middleware): self
{
$this->middlewares[] = $middleware;
@@ -507,10 +507,10 @@ abstract class Route implements IRoute
/**
* Add middleware class-name
*
* @param IMiddleware|string $middleware
* @param string $middleware
* @return static
*/
public function addMiddleware($middleware): IRoute
public function addMiddleware(string $middleware): IRoute
{
$this->middlewares[] = $middleware;
@@ -545,7 +545,7 @@ abstract class Route implements IRoute
* @param string $regex
* @return static
*/
public function setDefaultParameterRegex($regex)
public function setDefaultParameterRegex(string $regex): self
{
$this->defaultParameterRegex = $regex;
src/Pecee/SimpleRouter/Route/RouteController.php
+6 -6
View File
@@ -86,7 +86,7 @@ class RouteController extends LoadableRoute implements IControllerRoute
return '/' . trim($url, '/') . '/';
}
public function matchRoute($url, Request $request): bool
public function matchRoute(string $url, Request $request): bool
{
if ($this->getGroup() !== null && $this->getGroup()->matchRoute($url, $request) === false) {
return false;
@@ -167,17 +167,17 @@ class RouteController extends LoadableRoute implements IControllerRoute
/**
* Merge with information from another route.
*
* @param array $values
* @param array $settings
* @param bool $merge
* @return static
*/
public function setSettings(array $values, bool $merge = false): IRoute
public function setSettings(array $settings, bool $merge = false): IRoute
{
if (isset($values['names']) === true) {
$this->names = $values['names'];
if (isset($settings['names']) === true) {
$this->names = $settings['names'];
}
return parent::setSettings($values, $merge);
return parent::setSettings($settings, $merge);
}
}
src/Pecee/SimpleRouter/Route/RouteGroup.php
+12 -12
View File
@@ -49,7 +49,7 @@ class RouteGroup extends Route implements IGroupRoute
* @param Request $request
* @return bool
*/
public function matchRoute($url, Request $request): bool
public function matchRoute(string $url, Request $request): bool
{
if ($this->getGroup() !== null && $this->getGroup()->matchRoute($url, $request) === false) {
return false;
@@ -154,28 +154,28 @@ class RouteGroup extends Route implements IGroupRoute
/**
* Merge with information from another route.
*
* @param array $values
* @param array $settings
* @param bool $merge
* @return static
*/
public function setSettings(array $values, bool $merge = false): IRoute
public function setSettings(array $settings, bool $merge = false): IRoute
{
if (isset($values['prefix']) === true) {
$this->setPrefix($values['prefix'] . $this->prefix);
if (isset($settings['prefix']) === true) {
$this->setPrefix($settings['prefix'] . $this->prefix);
}
if ($merge === false && isset($values['exceptionHandler']) === true) {
$this->setExceptionHandlers((array)$values['exceptionHandler']);
if ($merge === false && isset($settings['exceptionHandler']) === true) {
$this->setExceptionHandlers((array)$settings['exceptionHandler']);
}
if ($merge === false && isset($values['domain']) === true) {
$this->setDomains((array)$values['domain']);
if ($merge === false && isset($settings['domain']) === true) {
$this->setDomains((array)$settings['domain']);
}
if (isset($values['as']) === true) {
if (isset($settings['as']) === true) {
$name = $values['as'];
$name = $settings['as'];
if ($this->name !== null && $merge !== false) {
$name .= '.' . $this->name;
@@ -184,7 +184,7 @@ class RouteGroup extends Route implements IGroupRoute
$this->name = $name;
}
return parent::setSettings($values, $merge);
return parent::setSettings($settings, $merge);
}
/**
src/Pecee/SimpleRouter/Route/RoutePartialGroup.php
+1 -1
View File
@@ -22,7 +22,7 @@ class RoutePartialGroup extends RouteGroup implements IPartialGroupRoute
* @param Request $request
* @return bool
*/
public function matchRoute($url, Request $request): bool
public function matchRoute(string $url, Request $request): bool
{
if ($this->getGroup() !== null && $this->getGroup()->matchRoute($url, $request) === false) {
return false;
src/Pecee/SimpleRouter/Route/RouteResource.php
+8 -8
View File
@@ -83,7 +83,7 @@ class RouteResource extends LoadableRoute implements IControllerRoute
return true;
}
public function matchRoute($url, Request $request): bool
public function matchRoute(string $url, Request $request): bool
{
if ($this->getGroup() !== null && $this->getGroup()->matchRoute($url, $request) === false) {
return false;
@@ -210,21 +210,21 @@ class RouteResource extends LoadableRoute implements IControllerRoute
/**
* Merge with information from another route.
*
* @param array $values
* @param array $settings
* @param bool $merge
* @return static
*/
public function setSettings(array $values, bool $merge = false): IRoute
public function setSettings(array $settings, bool $merge = false): IRoute
{
if (isset($values['names']) === true) {
$this->names = $values['names'];
if (isset($settings['names']) === true) {
$this->names = $settings['names'];
}
if (isset($values['methods']) === true) {
$this->methodNames = $values['methods'];
if (isset($settings['methods']) === true) {
$this->methodNames = $settings['methods'];
}
return parent::setSettings($values, $merge);
return parent::setSettings($settings, $merge);
}
}
src/Pecee/SimpleRouter/Route/RouteUrl.php
+1 -1
View File
@@ -12,7 +12,7 @@ class RouteUrl extends LoadableRoute
$this->setCallback($callback);
}
public function matchRoute($url, Request $request): bool
public function matchRoute(string $url, Request $request): bool
{
if ($this->getGroup() !== null && $this->getGroup()->matchRoute($url, $request) === false) {
return false;