Compare commits

..

44 Commits

Author SHA1 Message Date
Simon Sessingø 69bb570c73 Merge pull request #368 from skipperbent/v3-development
Version 3.5.0.0
2018-02-24 05:39:20 +01:00
Simon Sessingø c80b23e9d4 Merge pull request #365 from skipperbent/v3-development
Version 3.4.11.2
2018-02-19 23:07:02 +01:00
Simon Sessingø 9d88bf10d2 Merge pull request #363 from skipperbent/master
Sync
2018-02-19 16:37:04 +01:00
Simon Sessingø dfa4a9aa6c Merge pull request #362 from skipperbent/v3-development
Version 3.4.11.1
2018-02-19 16:36:27 +01:00
Simon Sessingø 7c789ea0f8 Merge pull request #361 from skipperbent/v3
V3
2018-02-14 12:39:31 +01:00
Simon Sessingø 3ba9dd01f0 Merge pull request #360 from skipperbent/v3-development
Version 3.4.11.0
2018-02-14 12:39:19 +01:00
Simon Sessingø 14360b6779 Merge pull request #353 from skipperbent/v3
V3
2018-01-14 15:54:49 +01:00
Simon Sessingø bbb81333b4 Merge pull request #352 from skipperbent/v3-development
Fixed Input::all when php://input is not available
2018-01-14 15:54:37 +01:00
Simon Sessingø 161fbf6ccf Merge pull request #351 from skipperbent/v3
V3
2018-01-06 03:33:23 +01:00
Simon Sessingø 9a7b598880 Merge pull request #350 from skipperbent/v3-development
Version 3.4.10.0
2018-01-06 03:33:13 +01:00
Simon Sessingø 1486095e9f Merge pull request #345 from skipperbent/v3
V3 sync
2017-12-17 10:41:58 +01:00
Simon Sessingø 2db20dce6b Merge pull request #344 from skipperbent/v3-development
Version 3.4.9.3
2017-12-17 10:41:22 +01:00
Simon Sessingø 7cb416cfc8 Merge pull request #342 from skipperbent/v3
V3
2017-12-17 09:53:49 +01:00
Simon Sessingø c6341960d7 Merge pull request #341 from skipperbent/v3-development
Version 3.4.9.2
2017-12-17 09:53:39 +01:00
Simon Sessingø a570322e25 Merge pull request #340 from skipperbent/v3
V3
2017-12-16 12:54:06 +01:00
Simon Sessingø 85cf925793 Merge pull request #339 from skipperbent/v3-development
Version 3.4.9.1
2017-12-16 12:53:56 +01:00
Simon Sessingø feb6c8bd41 Merge pull request #337 from skipperbent/v3
V3
2017-12-09 23:58:48 +01:00
Simon Sessingø 7c0a20115e Merge pull request #336 from skipperbent/v3-development
Version 3.4.9.0
2017-12-09 23:58:33 +01:00
Simon Sessingø 276f213ccc Merge pull request #335 from skipperbent/v3
V3
2017-12-06 19:06:20 +01:00
Simon Sessingø 877e0aa937 Merge pull request #334 from skipperbent/v3-development
Version 3.4.8.0
2017-12-06 19:06:09 +01:00
Simon Sessingø 56457448e4 Merge pull request #331 from skipperbent/v3
V3
2017-12-02 20:30:37 +01:00
Simon Sessingø 3e7767d978 Merge pull request #330 from skipperbent/v3-development
V3 development
2017-12-02 20:30:27 +01:00
Simon Sessingø 8ce1540771 Merge pull request #328 from skipperbent/v3
V3
2017-11-27 02:05:40 +01:00
Simon Sessingø 5ef9349b18 Merge pull request #327 from skipperbent/v3-development
Version 3.4.6.4
2017-11-27 02:05:17 +01:00
Simon Sessingø 3b305ceb00 Merge pull request #326 from skipperbent/v3
V3
2017-11-27 00:01:45 +01:00
Simon Sessingø 264f0a7b0f Merge pull request #325 from skipperbent/v3-development
Version 3.4.6.3
2017-11-27 00:01:30 +01:00
Simon Sessingø 1f00cf50e6 Merge pull request #324 from skipperbent/v3
V3
2017-11-26 23:44:17 +01:00
Simon Sessingø 5197ae2990 Merge pull request #323 from skipperbent/v3-development
Version 3.4.6.2
2017-11-26 23:44:06 +01:00
Simon Sessingø 32bc46be81 Merge pull request #322 from skipperbent/v3
V3
2017-11-26 18:46:25 +01:00
Simon Sessingø 9c701aabee Merge pull request #321 from skipperbent/v3-development
Fixed url parsing issues
2017-11-26 18:45:54 +01:00
Simon Sessingø 2b0821a557 Merge pull request #320 from skipperbent/v3-development
Fixed typo
2017-11-26 18:29:36 +01:00
Simon Sessingø 1ee71b9ec3 Merge pull request #319 from skipperbent/v3
V3
2017-11-26 18:08:36 +01:00
Simon Sessingø afc81d7005 Merge pull request #318 from skipperbent/v3-development
Version 3.4.6.0
2017-11-26 18:08:24 +01:00
Simon Sessingø 0b8931a2e1 Merge pull request #316 from skipperbent/v3
V3
2017-11-25 01:35:03 +01:00
Simon Sessingø 496d3e7182 Merge pull request #315 from skipperbent/v3-development
Version 3.4.5.5
2017-11-25 01:34:53 +01:00
Simon Sessingø 2472079642 Merge pull request #312 from skipperbent/v3
V3
2017-11-10 13:03:02 +01:00
Simon Sessingø 1fd13ed2aa Merge pull request #311 from skipperbent/v3-development
V3 development
2017-11-10 13:02:49 +01:00
Simon Sessingø 4409fbcf4e Merge pull request #309 from skipperbent/v3
V3
2017-11-10 08:25:22 +01:00
Simon Sessingø 9d5c4a2ed1 Merge pull request #308 from skipperbent/v3-development
3.4.5.4
2017-11-10 08:24:55 +01:00
Simon Sessingø b8634bcf79 Merge pull request #307 from skipperbent/revert-306-revert-305-v3-development
Revert "Revert "V3 development""
2017-11-08 04:11:50 +01:00
Simon Sessingø 6ad22a3816 Revert "Revert "V3 development"" 2017-11-08 04:11:40 +01:00
Simon Sessingø ed41cd55af Merge pull request #306 from skipperbent/revert-305-v3-development
Revert "V3 development"
2017-11-08 04:09:55 +01:00
Simon Sessingø ebeca952cf Revert "V3 development" 2017-11-08 04:09:41 +01:00
Simon Sessingø 0672e85fd7 Merge pull request #305 from skipperbent/v3-development
V3 development
2017-11-08 04:09:31 +01:00
81 changed files with 1153 additions and 3503 deletions
-22
View File
@@ -1,22 +0,0 @@
engines:
phpmd:
enabled: true
checks:
Design/TooManyPublicMethods:
enabled: true
Naming/ShortVariable:
enabled: true
CleanCode/StaticAccess:
enabled: true
Controversial/CamelCaseMethodName:
enabled: true
fixme:
enabled: true
duplication:
enabled: true
config:
languages:
- php:
ratings:
paths:
- src/**
+1 -2
View File
@@ -1,4 +1,3 @@
.idea
composer.lock
vendor/
tests/tmp/*
vendor/
-13
View File
@@ -1,13 +0,0 @@
build:
tests:
override:
-
command: './vendor/bin/phpunit --coverage-clover=coverage.clover'
coverage:
file: 'coverage.clover'
format: 'clover'
checks:
php:
code_rating: true
duplication: true
-13
View File
@@ -1,13 +0,0 @@
sudo: false
language: php
php:
- 7.1
before_script:
- curl -sS http://getcomposer.org/installer | php
- php composer.phar install --prefer-source --no-interaction
script:
- ./vendor/bin/phpunit
+108 -623
View File
File diff suppressed because it is too large Load Diff
+3 -5
View File
@@ -27,16 +27,14 @@
}
],
"require": {
"php": ">=7.1",
"php-di/php-di": "^6.0"
"php": ">=5.4.0"
},
"require-dev": {
"phpunit/phpunit": "^6.0",
"mockery/mockery": "^1"
"phpunit/phpunit": "4.7.7"
},
"autoload": {
"psr-4": {
"Pecee\\": "src/Pecee/"
}
}
}
}
+9 -21
View File
@@ -1,9 +1,6 @@
<?php
use Pecee\SimpleRouter\SimpleRouter as Router;
use \Pecee\Http\Url;
use \Pecee\Http\Response;
use \Pecee\Http\Request;
/**
* Get url for a route by using either name/alias, class or method name.
@@ -20,10 +17,10 @@ use \Pecee\Http\Request;
* @param string|null $name
* @param string|array|null $parameters
* @param array|null $getParams
* @return \Pecee\Http\Url
* @return string
* @throws \InvalidArgumentException
*/
function url(?string $name = null, $parameters = null, ?array $getParams = null): Url
function url($name = null, $parameters = null, $getParams = null)
{
return Router::getUrl($name, $parameters, $getParams);
}
@@ -31,7 +28,7 @@ function url(?string $name = null, $parameters = null, ?array $getParams = null)
/**
* @return \Pecee\Http\Response
*/
function response(): Response
function response()
{
return Router::response();
}
@@ -39,7 +36,7 @@ function response(): Response
/**
* @return \Pecee\Http\Request
*/
function request(): Request
function request()
{
return Router::request();
}
@@ -49,27 +46,18 @@ function request(): Request
* @param string|null $index Parameter index name
* @param string|null $defaultValue Default return value
* @param string|array|null $methods Default method
* @return \Pecee\Http\Input\InputHandler|\Pecee\Http\Input\IInputItem|string
* @return \Pecee\Http\Input\Input|string
*/
function input($index = null, $defaultValue = null, $methods = null)
{
if ($index !== null) {
if ($defaultValue !== null) {
return request()->getInputHandler()->getValue($index, $defaultValue, $methods);
}
return request()->getInputHandler()->get($index, $methods);
return request()->getInput()->get($index, $defaultValue, $methods);
}
return request()->getInputHandler();
return request()->getInput();
}
/**
* @param string $url
* @param int|null $code
*/
function redirect(string $url, ?int $code = null): void
function redirect($url, $code = null)
{
if ($code !== null) {
response()->httpCode($code);
@@ -82,7 +70,7 @@ function redirect(string $url, ?int $code = null): void
* Get current csrf-token
* @return string|null
*/
function csrf_token(): ?string
function csrf_token()
{
$baseVerifier = Router::router()->getCsrfVerifier();
if ($baseVerifier !== null) {
-24
View File
@@ -1,24 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<phpunit
backupGlobals="false"
backupStaticAttributes="false"
colors="true"
bootstrap="tests/bootstrap.php"
convertErrorsToExceptions="true"
convertNoticesToExceptions="true"
convertWarningsToExceptions="true"
processIsolation="false"
stopOnFailure="false"
syntaxCheck="false">
<testsuites>
<testsuite name="SimpleRouter Test Suite">
<directory>tests/Pecee/SimpleRouter/</directory>
</testsuite>
</testsuites>
<filter>
<whitelist processUncoveredFilesFromWhitelist="true">
<directory suffix=".php">src</directory>
</whitelist>
</filter>
</phpunit>
+14 -15
View File
@@ -1,48 +1,47 @@
<?php
namespace Pecee\Controllers;
interface IResourceController
{
/**
* @return string|null
* @return void
*/
public function index(): ?string;
public function index();
/**
* @param mixed $id
* @return string|null
* @return void
*/
public function show($id): ?string;
public function show($id);
/**
* @return string|null
* @return void
*/
public function store(): ?string;
public function store();
/**
* @return string|null
* @return void
*/
public function create(): ?string;
public function create();
/**
* View
* @param mixed $id
* @return string|null
* @return void
*/
public function edit($id): ?string;
public function edit($id);
/**
* @param mixed $id
* @return string|null
* @return void
*/
public function update($id): ?string;
public function update($id);
/**
* @param mixed $id
* @return string|null
* @return void
*/
public function destroy($id): ?string;
public function destroy($id);
}
@@ -1,8 +0,0 @@
<?php
namespace Pecee\Exceptions;
class InvalidArgumentException extends \InvalidArgumentException
{
}
@@ -1,6 +1,6 @@
<?php
namespace Pecee\SimpleRouter\Handlers;
namespace Pecee\Handlers;
use Pecee\Http\Request;
@@ -10,7 +10,7 @@ use Pecee\Http\Request;
* Class is used to create callbacks which are fired when an exception is reached.
* This allows for easy handling 404-exception etc. without creating an custom ExceptionHandler.
*
* @package \Pecee\SimpleRouter\Handlers
* @package Pecee\Handlers
*/
class CallbackExceptionHandler implements IExceptionHandler
{
@@ -25,11 +25,12 @@ class CallbackExceptionHandler implements IExceptionHandler
/**
* @param Request $request
* @param \Exception $error
* @return Request|null
*/
public function handleError(Request $request, \Exception $error): void
public function handleError(Request $request, \Exception $error)
{
/* Fire exceptions */
\call_user_func($this->callback,
return call_user_func($this->callback,
$request,
$error
);
@@ -1,6 +1,5 @@
<?php
namespace Pecee\SimpleRouter\Handlers;
namespace Pecee\Handlers;
use Pecee\Http\Request;
@@ -9,7 +8,8 @@ interface IExceptionHandler
/**
* @param Request $request
* @param \Exception $error
* @return Request|null
*/
public function handleError(Request $request, \Exception $error): void;
public function handleError(Request $request, \Exception $error);
}
@@ -1,8 +0,0 @@
<?php
namespace Pecee\Http\Exceptions;
class MalformedUrlException extends \Exception
{
}
+5 -8
View File
@@ -1,21 +1,18 @@
<?php
namespace Pecee\Http\Input;
interface IInputItem
{
public function getIndex(): string;
public function getIndex();
public function setIndex(string $index): self;
public function setIndex($index);
public function getName(): string;
public function getName();
public function setName(string $name): self;
public function setName($name);
public function getValue(): string;
public function setValue(string $value): self;
public function getValue();
public function __toString();
@@ -2,10 +2,9 @@
namespace Pecee\Http\Input;
use Pecee\Exceptions\InvalidArgumentException;
use Pecee\Http\Request;
class InputHandler
class Input
{
/**
* @var array
@@ -27,10 +26,6 @@ class InputHandler
*/
protected $request;
/**
* Input constructor.
* @param Request $request
*/
public function __construct(Request $request)
{
$this->request = $request;
@@ -38,55 +33,45 @@ class InputHandler
$this->parseInputs();
}
/**
* Parse input values
*
*/
public function parseInputs(): void
public function parseInputs()
{
/* Parse get requests */
if (\count($_GET) !== 0) {
if (count($_GET) !== 0) {
$this->get = $this->handleGetPost($_GET);
}
/* Parse post requests */
$postVars = $_POST;
if (\in_array($this->request->getMethod(), ['put', 'patch', 'delete'], false) === true) {
if (in_array($this->request->getMethod(), ['put', 'patch', 'delete'], false) === true) {
parse_str(file_get_contents('php://input'), $postVars);
}
if (\count($postVars) !== 0) {
if (count($postVars) !== 0) {
$this->post = $this->handleGetPost($postVars);
}
/* Parse get requests */
if (\count($_FILES) !== 0) {
if (count($_FILES) !== 0) {
$this->file = $this->parseFiles();
}
}
/**
* @return array
*/
public function parseFiles(): array
public function parseFiles()
{
$list = [];
foreach ((array)$_FILES as $key => $value) {
// Handle array input
if (\is_array($value['name']) === false) {
if (is_array($value['name']) === false) {
$values['index'] = $key;
try {
$list[$key] = InputFile::createFromArray($values + $value);
} catch (InvalidArgumentException $e) {
}
$list[$key] = InputFile::createFromArray($values + $value);
continue;
}
$keys = [$key];
$files = $this->rearrangeFiles($value['name'], $keys, $value);
if (isset($list[$key]) === true) {
@@ -100,7 +85,7 @@ class InputHandler
return $list;
}
protected function rearrangeFiles(array $values, &$index, $original): array
protected function rearrangeFiles(array $values, &$index, $original)
{
$originalIndex = $index[0];
@@ -110,30 +95,24 @@ class InputHandler
foreach ($values as $key => $value) {
if (\is_array($original['name'][$key]) === false) {
if (is_array($original['name'][$key]) === false) {
try {
$file = InputFile::createFromArray([
'index' => (empty($key) === true && empty($originalIndex) === false) ? $originalIndex : $key,
'name' => $original['name'][$key],
'error' => $original['error'][$key],
'tmp_name' => $original['tmp_name'][$key],
'type' => $original['type'][$key],
'size' => $original['size'][$key],
]);
$file = InputFile::createFromArray([
'index' => (empty($key) === true && empty($originalIndex) === false) ? $originalIndex : $key,
'name' => $original['name'][$key],
'error' => $original['error'][$key],
'tmp_name' => $original['tmp_name'][$key],
'type' => $original['type'][$key],
'size' => $original['size'][$key],
]);
if (isset($output[$key]) === true) {
$output[$key][] = $file;
continue;
}
$output[$key] = $file;
if (isset($output[$key]) === true) {
$output[$key][] = $file;
continue;
} catch (InvalidArgumentException $e) {
}
$output[$key] = $file;
continue;
}
$index[] = $key;
@@ -151,14 +130,14 @@ class InputHandler
return $output;
}
protected function handleGetPost(array $array): array
protected function handleGetPost(array $array)
{
$list = [];
foreach ($array as $key => $value) {
// Handle array input
if (\is_array($value) === false) {
if (is_array($value) === false) {
$list[$key] = new InputItem($key, $value);
continue;
}
@@ -178,9 +157,9 @@ class InputHandler
* @param string|null $defaultValue
* @return InputItem|string
*/
public function findPost(string $index, ?string $defaultValue = null)
public function findPost($index, $defaultValue = null)
{
return $this->post[$index] ?? $defaultValue;
return isset($this->post[$index]) ? $this->post[$index] : $defaultValue;
}
/**
@@ -190,9 +169,9 @@ class InputHandler
* @param string|null $defaultValue
* @return InputFile|string
*/
public function findFile(string $index, ?string $defaultValue = null)
public function findFile($index, $defaultValue = null)
{
return $this->file[$index] ?? $defaultValue;
return isset($this->file[$index]) ? $this->file[$index] : $defaultValue;
}
/**
@@ -202,35 +181,40 @@ class InputHandler
* @param string|null $defaultValue
* @return InputItem|string
*/
public function findGet(string $index, ?string $defaultValue = null)
public function findGet($index, $defaultValue = null)
{
return $this->get[$index] ?? $defaultValue;
return isset($this->get[$index]) ? $this->get[$index] : $defaultValue;
}
/**
* Get input object
*
* @param string $index
* @param array ...$methods
* @return IInputItem|null
* @param string|null $defaultValue
* @param array|string|null $methods
* @return IInputItem|string
*/
public function get(string $index, ...$methods): ?IInputItem
public function getObject($index, $defaultValue = null, $methods = null)
{
if ($methods !== null && is_string($methods) === true) {
$methods = [$methods];
}
$element = null;
if (\count($methods) === 0 || \in_array('get', $methods, true) === true) {
if ($methods === null || in_array('get', $methods, false) === true) {
$element = $this->findGet($index);
}
if (($element === null && \count($methods) === 0) || (\count($methods) === 0 && \in_array('post', $methods, true) === true)) {
if (($element === null && $methods === null) || ($methods !== null && in_array('post', $methods, false) === true)) {
$element = $this->findPost($index);
}
if (($element === null && \count($methods) === 0) || (\count($methods) === 0 && \in_array('file', $methods, true) === true)) {
if (($element === null && $methods === null) || ($methods !== null && in_array('file', $methods, false) === true)) {
$element = $this->findFile($index);
}
return $element;
return ($element !== null) ? $element : $defaultValue;
}
/**
@@ -238,14 +222,14 @@ class InputHandler
*
* @param string $index
* @param string|null $defaultValue
* @param array ...$methods
* @return string
* @param array|string|null $methods
* @return InputItem|string
*/
public function getValue(string $index, ?string $defaultValue = null, ...$methods): ?string
public function get($index, $defaultValue = null, $methods = null)
{
$input = $this->get($index, $methods);
$input = $this->getObject($index, $defaultValue, $methods);
if ($input !== null) {
if ($input instanceof InputItem) {
return (trim($input->getValue()) === '') ? $defaultValue : $input->getValue();
}
@@ -256,12 +240,11 @@ class InputHandler
* Check if a input-item exist
*
* @param string $index
* @param array ...$method
* @return bool
*/
public function exists(string $index, ...$method): bool
public function exists($index)
{
return $this->get($index, $method) !== null;
return ($this->getObject($index) !== null);
}
/**
@@ -269,18 +252,14 @@ class InputHandler
* @param array|null $filter Only take items in filter
* @return array
*/
public function all(array $filter = null): array
public function all(array $filter = null)
{
$output = $_GET;
$output = $_GET + $_POST;
if ($this->request->getMethod() === 'post') {
// Append POST data
$output += $_POST;
$contents = file_get_contents('php://input');
// Append any PHP-input json
if (strpos(trim($contents), '{') === 0) {
$post = json_decode($contents, true);
if ($post !== false) {
+33 -46
View File
@@ -2,8 +2,6 @@
namespace Pecee\Http\Input;
use Pecee\Exceptions\InvalidArgumentException;
class InputFile implements IInputItem
{
public $index;
@@ -14,7 +12,7 @@ class InputFile implements IInputItem
public $errors;
public $tmpName;
public function __construct(string $index)
public function __construct($index)
{
$this->index = $index;
@@ -28,13 +26,13 @@ class InputFile implements IInputItem
* Create from array
*
* @param array $values
* @throws InvalidArgumentException
* @throws \InvalidArgumentException
* @return static
*/
public static function createFromArray(array $values): self
public static function createFromArray(array $values)
{
if (isset($values['index']) === false) {
throw new InvalidArgumentException('Index key is required');
throw new \InvalidArgumentException('Index key is required');
}
/* Easy way of ensuring that all indexes-are set and not filling the screen with isset() */
@@ -48,7 +46,7 @@ class InputFile implements IInputItem
];
return (new static($values['index']))
->setSize((int)$values['size'])
->setSize($values['size'])
->setError($values['error'])
->setType($values['type'])
->setTmpName($values['tmp_name'])
@@ -59,7 +57,7 @@ class InputFile implements IInputItem
/**
* @return string
*/
public function getIndex(): string
public function getIndex()
{
return $this->index;
}
@@ -67,9 +65,9 @@ class InputFile implements IInputItem
/**
* Set input index
* @param string $index
* @return static
* @return static $this
*/
public function setIndex(string $index): IInputItem
public function setIndex($index)
{
$this->index = $index;
@@ -79,7 +77,7 @@ class InputFile implements IInputItem
/**
* @return string
*/
public function getSize(): string
public function getSize()
{
return $this->size;
}
@@ -87,9 +85,9 @@ class InputFile implements IInputItem
/**
* Set file size
* @param int $size
* @return static
* @return static $this
*/
public function setSize(int $size): IInputItem
public function setSize($size)
{
$this->size = $size;
@@ -100,7 +98,7 @@ class InputFile implements IInputItem
* Get mime-type of file
* @return string
*/
public function getMime(): string
public function getMime()
{
return $this->getType();
}
@@ -108,7 +106,7 @@ class InputFile implements IInputItem
/**
* @return string
*/
public function getType(): string
public function getType()
{
return $this->type;
}
@@ -116,9 +114,9 @@ class InputFile implements IInputItem
/**
* Set type
* @param string $type
* @return static
* @return static $this
*/
public function setType(string $type): IInputItem
public function setType($type)
{
$this->type = $type;
@@ -130,7 +128,7 @@ class InputFile implements IInputItem
*
* @return string
*/
public function getExtension(): string
public function getExtension()
{
return pathinfo($this->getFilename(), PATHINFO_EXTENSION);
}
@@ -140,7 +138,7 @@ class InputFile implements IInputItem
*
* @return string
*/
public function getName(): string
public function getName()
{
return $this->name;
}
@@ -150,9 +148,9 @@ class InputFile implements IInputItem
* Useful for adding validation etc.
*
* @param string $name
* @return static
* @return static $this
*/
public function setName(string $name): IInputItem
public function setName($name)
{
$this->name = $name;
@@ -163,9 +161,9 @@ class InputFile implements IInputItem
* Set filename
*
* @param string $name
* @return static
* @return static $this
*/
public function setFilename($name): IInputItem
public function setFilename($name)
{
$this->filename = $name;
@@ -177,7 +175,7 @@ class InputFile implements IInputItem
*
* @return string mixed
*/
public function getFilename(): string
public function getFilename()
{
return $this->filename;
}
@@ -188,7 +186,7 @@ class InputFile implements IInputItem
* @param string $destination
* @return bool
*/
public function move($destination): bool
public function move($destination)
{
return move_uploaded_file($this->tmpName, $destination);
}
@@ -198,7 +196,7 @@ class InputFile implements IInputItem
*
* @return string
*/
public function getContents(): string
public function getContents()
{
return file_get_contents($this->tmpName);
}
@@ -208,7 +206,7 @@ class InputFile implements IInputItem
*
* @return bool
*/
public function hasError(): bool
public function hasError()
{
return ($this->getError() !== 0);
}
@@ -218,7 +216,7 @@ class InputFile implements IInputItem
*
* @return string
*/
public function getError(): string
public function getError()
{
return $this->errors;
}
@@ -227,9 +225,9 @@ class InputFile implements IInputItem
* Set error
*
* @param int $error
* @return static
* @return static $this
*/
public function setError($error): IInputItem
public function setError($error)
{
$this->errors = (int)$error;
@@ -239,7 +237,7 @@ class InputFile implements IInputItem
/**
* @return string
*/
public function getTmpName(): string
public function getTmpName()
{
return $this->tmpName;
}
@@ -247,9 +245,9 @@ class InputFile implements IInputItem
/**
* Set file temp. name
* @param string $name
* @return static
* @return static $this
*/
public function setTmpName($name): IInputItem
public function setTmpName($name)
{
$this->tmpName = $name;
@@ -261,23 +259,12 @@ class InputFile implements IInputItem
return $this->getTmpName();
}
public function getValue(): string
public function getValue()
{
return $this->getFilename();
}
/**
* @param string $value
* @return static
*/
public function setValue(string $value): IInputItem
{
$this->filename = $value;
return $this;
}
public function toArray(): array
public function toArray()
{
return [
'tmp_name' => $this->tmpName,
+9 -10
View File
@@ -1,5 +1,4 @@
<?php
namespace Pecee\Http\Input;
class InputItem implements IInputItem
@@ -8,7 +7,7 @@ class InputItem implements IInputItem
public $name;
public $value;
public function __construct(string $index, ?string $value = null)
public function __construct($index, $value = null)
{
$this->index = $index;
$this->value = $value;
@@ -20,12 +19,12 @@ class InputItem implements IInputItem
/**
* @return string
*/
public function getIndex(): string
public function getIndex()
{
return $this->index;
}
public function setIndex(string $index): IInputItem
public function setIndex($index)
{
$this->index = $index;
@@ -35,7 +34,7 @@ class InputItem implements IInputItem
/**
* @return string
*/
public function getName(): string
public function getName()
{
return $this->name;
}
@@ -43,9 +42,9 @@ class InputItem implements IInputItem
/**
* Set input name
* @param string $name
* @return static
* @return static $this
*/
public function setName(string $name): IInputItem
public function setName($name)
{
$this->name = $name;
@@ -55,7 +54,7 @@ class InputItem implements IInputItem
/**
* @return string
*/
public function getValue(): string
public function getValue()
{
return $this->value;
}
@@ -63,9 +62,9 @@ class InputItem implements IInputItem
/**
* Set input value
* @param string $value
* @return static
* @return static $this
*/
public function setValue(string $value): IInputItem
public function setValue($value)
{
$this->value = $value;
+19 -22
View File
@@ -9,16 +9,12 @@ use Pecee\Http\Security\ITokenProvider;
class BaseCsrfVerifier implements IMiddleware
{
public const POST_KEY = 'csrf-token';
public const HEADER_KEY = 'X-CSRF-TOKEN';
const POST_KEY = 'csrf-token';
const HEADER_KEY = 'X-CSRF-TOKEN';
protected $except;
protected $tokenProvider;
/**
* BaseCsrfVerifier constructor.
* @throws \Pecee\Http\Security\Exceptions\SecurityException
*/
public function __construct()
{
$this->tokenProvider = new CookieTokenProvider();
@@ -29,23 +25,23 @@ class BaseCsrfVerifier implements IMiddleware
* @param Request $request
* @return bool
*/
protected function skip(Request $request): bool
protected function skip(Request $request)
{
if ($this->except === null || \count($this->except) === 0) {
if ($this->except === null || count($this->except) === 0) {
return false;
}
$max = \count($this->except) - 1;
$max = count($this->except) - 1;
for ($i = $max; $i >= 0; $i--) {
$url = $this->except[$i];
$url = rtrim($url, '/');
if ($url[\strlen($url) - 1] === '*') {
if ($url[strlen($url) - 1] === '*') {
$url = rtrim($url, '*');
$skip = $request->getUrl()->contains($url);
$skip = (stripos($request->getUri()->getPath(), $url) === 0);
} else {
$skip = ($url === $request->getUrl()->getOriginalUrl());
$skip = ($url === $request->getUri()->getPath());
}
if ($skip === true) {
@@ -62,18 +58,19 @@ class BaseCsrfVerifier implements IMiddleware
* @param Request $request
* @throws TokenMismatchException
*/
public function handle(Request $request): void
public function handle(Request $request)
{
if ($this->skip($request) === false && \in_array($request->getMethod(), ['post', 'put', 'delete'], true) === true) {
if ($this->skip($request) === false && in_array($request->getMethod(), ['post', 'put', 'delete'], false) === true) {
$token = $request->getInputHandler()->getValue(
static::POST_KEY,
$request->getHeader(static::HEADER_KEY),
'post'
);
$token = $request->getInput()->get(static::POST_KEY, null, 'post');
if ($this->tokenProvider->validate((string)$token) === false) {
// If the token is not posted, check headers for valid x-csrf-token
if ($token === null) {
$token = $request->getHeader(static::HEADER_KEY);
}
if ($this->tokenProvider->validate($token) === false) {
throw new TokenMismatchException('Invalid CSRF-token.');
}
@@ -84,7 +81,7 @@ class BaseCsrfVerifier implements IMiddleware
}
public function getTokenProvider(): ITokenProvider
public function getTokenProvider()
{
return $this->tokenProvider;
}
@@ -93,7 +90,7 @@ class BaseCsrfVerifier implements IMiddleware
* Set token provider
* @param ITokenProvider $provider
*/
public function setTokenProvider(ITokenProvider $provider): void
public function setTokenProvider(ITokenProvider $provider)
{
$this->tokenProvider = $provider;
}
@@ -1,5 +1,4 @@
<?php
namespace Pecee\Http\Middleware\Exceptions;
class TokenMismatchException extends \Exception
+2 -2
View File
@@ -1,5 +1,4 @@
<?php
namespace Pecee\Http\Middleware;
use Pecee\Http\Request;
@@ -8,7 +7,8 @@ interface IMiddleware
{
/**
* @param Request $request
* @return Request|null
*/
public function handle(Request $request): void;
public function handle(Request $request);
}
+84 -170
View File
@@ -2,128 +2,81 @@
namespace Pecee\Http;
use Pecee\Http\Exceptions\MalformedUrlException;
use Pecee\Http\Input\InputHandler;
use Pecee\Http\Input\Input;
use Pecee\SimpleRouter\Route\ILoadableRoute;
use Pecee\SimpleRouter\Route\RouteUrl;
use Pecee\SimpleRouter\SimpleRouter;
class Request
{
/**
* Additional data
*
* @var array
*/
private $data = [];
/**
* Server headers
* @var array
*/
protected $headers = [];
/**
* Request host
* @var string
*/
protected $headers;
protected $host;
/**
* Current request url
* @var Url
*/
protected $url;
/**
* Request method
* @var string
*/
protected $uri;
protected $method;
protected $input;
/**
* Input handler
* @var InputHandler
*/
protected $inputHandler;
/**
* Defines if request has pending rewrite
* @var bool
*/
protected $hasPendingRewrite = false;
protected $hasRewrite = false;
/**
* @var ILoadableRoute|null
*/
protected $rewriteRoute;
/**
* Rewrite url
* @var string|null
*/
protected $rewriteUrl;
/**
* @var array
* @var ILoadableRoute|null
*/
protected $loadedRoutes = [];
protected $loadedRoute;
/**
* Request constructor.
* @throws MalformedUrlException
*/
public function __construct()
{
$this->parseHeaders();
$this->setHost($this->getHeader('http-host'));
// Check if special IIS header exist, otherwise use default.
$this->setUri(new Uri($this->getHeader('unencoded-url', $this->getHeader('request-uri'))));
$this->input = new Input($this);
$this->method = strtolower($this->input->get('_method', $this->getHeader('request-method')));
}
protected function parseHeaders()
{
$this->headers = [];
foreach ($_SERVER as $key => $value) {
$this->headers[strtolower($key)] = $value;
$this->headers[strtolower(str_replace('_', '-', $key))] = $value;
}
$this->setHost($this->getHeader('http-host'));
// Check if special IIS header exist, otherwise use default.
$this->setUrl(new Url($this->getHeader('unencoded-url', $this->getHeader('request-uri'))));
$this->inputHandler = new InputHandler($this);
$this->method = strtolower($this->inputHandler->getValue('_method', $this->getHeader('request-method')));
}
public function isSecure(): bool
public function isSecure()
{
return $this->getHeader('http-x-forwarded-proto') === 'https' || $this->getHeader('https') !== null || $this->getHeader('server-port') === 443;
}
/**
* @return Url
* @return Uri
*/
public function getUrl(): Url
public function getUri()
{
return $this->url;
return $this->uri;
}
/**
* Copy url object
*
* @return Url
* @return string
*/
public function getUrlCopy(): Url
{
return clone $this->url;
}
/**
* @return string|null
*/
public function getHost(): ?string
public function getHost()
{
return $this->host;
}
/**
* @return string|null
* @return string
*/
public function getMethod(): ?string
public function getMethod()
{
return $this->method;
}
@@ -132,7 +85,7 @@ class Request
* Get http basic auth user
* @return string|null
*/
public function getUser(): ?string
public function getUser()
{
return $this->getHeader('php-auth-user');
}
@@ -141,7 +94,7 @@ class Request
* Get http basic auth password
* @return string|null
*/
public function getPassword(): ?string
public function getPassword()
{
return $this->getHeader('php-auth-pw');
}
@@ -150,16 +103,16 @@ class Request
* Get all headers
* @return array
*/
public function getHeaders(): array
public function getHeaders()
{
return $this->headers;
}
/**
* Get id address
* @return string|null
* @return string
*/
public function getIp(): ?string
public function getIp()
{
if ($this->getHeader('http-cf-connecting-ip') !== null) {
return $this->getHeader('http-cf-connecting-ip');
@@ -176,27 +129,27 @@ class Request
* Get remote address/ip
*
* @alias static::getIp
* @return string|null
* @return string
*/
public function getRemoteAddr(): ?string
public function getRemoteAddr()
{
return $this->getIp();
}
/**
* Get referer
* @return string|null
* @return string
*/
public function getReferer(): ?string
public function getReferer()
{
return $this->getHeader('http-referer');
}
/**
* Get user agent
* @return string|null
* @return string
*/
public function getUserAgent(): ?string
public function getUserAgent()
{
return $this->getHeader('http-user-agent');
}
@@ -209,18 +162,18 @@ class Request
*
* @return string|null
*/
public function getHeader($name, $defaultValue = null): ?string
public function getHeader($name, $defaultValue = null)
{
return $this->headers[strtolower($name)] ?? $defaultValue;
return isset($this->headers[strtolower($name)]) ? $this->headers[strtolower($name)] : $defaultValue;
}
/**
* Get input class
* @return InputHandler
* @return Input
*/
public function getInputHandler(): InputHandler
public function getInput()
{
return $this->inputHandler;
return $this->input;
}
/**
@@ -230,46 +183,36 @@ class Request
*
* @return bool
*/
public function isFormatAccepted($format): bool
public function isFormatAccepted($format)
{
return ($this->getHeader('http-accept') !== null && stripos($this->getHeader('http-accept'), $format) !== false);
}
/**
* Returns true if the request is made through Ajax
*
* @return bool
*/
public function isAjax(): bool
{
return (strtolower($this->getHeader('http-x-requested-with')) === 'xmlhttprequest');
return ($this->getHeader('http-accept') !== null && stripos($this->getHeader('http-accept'), $format) > -1);
}
/**
* Get accept formats
* @return array
*/
public function getAcceptFormats(): array
public function getAcceptFormats()
{
return explode(',', $this->getHeader('http-accept'));
}
/**
* @param Url $url
* @param Uri|string $uri
*/
public function setUrl(Url $url): void
public function setUri($uri)
{
$this->url = $url;
if ($this->url->getHost() === null) {
$this->url->setHost((string)$this->getHost());
if (is_string($uri) === true) {
$uri = new Uri($uri);
}
$this->uri = $uri;
}
/**
* @param string|null $host
* @param string $host
*/
public function setHost(?string $host): void
public function setHost($host)
{
$this->host = $host;
}
@@ -277,7 +220,7 @@ class Request
/**
* @param string $method
*/
public function setMethod(string $method): void
public function setMethod($method)
{
$this->method = $method;
}
@@ -288,9 +231,9 @@ class Request
* @param ILoadableRoute $route
* @return static
*/
public function setRewriteRoute(ILoadableRoute $route): self
public function setRewriteRoute(ILoadableRoute $route)
{
$this->hasPendingRewrite = true;
$this->hasRewrite = true;
$this->rewriteRoute = SimpleRouter::addDefaultNamespace($route);
return $this;
@@ -301,7 +244,7 @@ class Request
*
* @return ILoadableRoute|null
*/
public function getRewriteRoute(): ?ILoadableRoute
public function getRewriteRoute()
{
return $this->rewriteRoute;
}
@@ -309,9 +252,9 @@ class Request
/**
* Get rewrite url
*
* @return string|null
* @return string
*/
public function getRewriteUrl(): ?string
public function getRewriteUrl()
{
return $this->rewriteUrl;
}
@@ -322,9 +265,9 @@ class Request
* @param string $rewriteUrl
* @return static
*/
public function setRewriteUrl(string $rewriteUrl): self
public function setRewriteUrl($rewriteUrl)
{
$this->hasPendingRewrite = true;
$this->hasRewrite = true;
$this->rewriteUrl = rtrim($rewriteUrl, '/') . '/';
return $this;
@@ -332,87 +275,58 @@ class Request
/**
* Set rewrite callback
* @param string|\Closure $callback
* @param string $callback
* @return static
*/
public function setRewriteCallback($callback): self
public function setRewriteCallback($callback)
{
$this->hasPendingRewrite = true;
$this->hasRewrite = true;
return $this->setRewriteRoute(new RouteUrl($this->getUrl()->getPath(), $callback));
return $this->setRewriteRoute(new RouteUrl($this->getUri()->getPath(), $callback));
}
/**
* Get loaded route
* @return ILoadableRoute|null
*/
public function getLoadedRoute(): ?ILoadableRoute
public function getLoadedRoute()
{
return (\count($this->loadedRoutes) > 0) ? end($this->loadedRoutes) : null;
return $this->loadedRoute;
}
/**
* Get all loaded routes
*
* @return array
*/
public function getLoadedRoutes(): array
{
return $this->loadedRoutes;
}
/**
* Set loaded routes
*
* @param array $routes
* @return static
*/
public function setLoadedRoutes(array $routes): self
{
$this->loadedRoutes = $routes;
return $this;
}
/**
* Added loaded route
* Set loaded route
*
* @param ILoadableRoute $route
* @return static
*/
public function addLoadedRoute(ILoadableRoute $route): self
public function setLoadedRoute(ILoadableRoute $route)
{
$this->loadedRoutes[] = $route;
$this->loadedRoute = $route;
return $this;
}
/**
* Returns true if the request contains a rewrite
*
* @return bool
*/
public function hasPendingRewrite(): bool
public function hasRewrite()
{
return $this->hasPendingRewrite;
return $this->hasRewrite;
}
/**
* Defines if the current request contains a rewrite.
*
* @param bool $boolean
* @return Request
*/
public function setHasPendingRewrite(bool $boolean): self
public function setHasRewrite($value)
{
$this->hasPendingRewrite = $boolean;
$this->hasRewrite = $value;
return $this;
}
public function isRewrite($url)
{
return ($this->rewriteUrl === $url);
}
public function __isset($name)
{
return array_key_exists($name, $this->data) === true;
return array_key_exists($name, $this->data);
}
public function __set($name, $value = null)
@@ -422,7 +336,7 @@ class Request
public function __get($name)
{
return $this->data[$name] ?? null;
return isset($this->data[$name]) ? $this->data[$name] : null;
}
}
+17 -18
View File
@@ -2,8 +2,6 @@
namespace Pecee\Http;
use Pecee\Exceptions\InvalidArgumentException;
class Response
{
protected $request;
@@ -19,7 +17,7 @@ class Response
* @param int $code
* @return static
*/
public function httpCode(int $code): self
public function httpCode($code)
{
http_response_code($code);
@@ -32,7 +30,7 @@ class Response
* @param string $url
* @param int $httpCode
*/
public function redirect(string $url, ?int $httpCode = null): void
public function redirect($url, $httpCode = null)
{
if ($httpCode !== null) {
$this->httpCode($httpCode);
@@ -42,9 +40,9 @@ class Response
exit(0);
}
public function refresh(): void
public function refresh()
{
$this->redirect($this->request->getUrl()->getOriginalUrl());
$this->redirect($this->request->getUri()->getOriginalUrl());
}
/**
@@ -52,7 +50,7 @@ class Response
* @param string $name
* @return static
*/
public function auth(string $name = ''): self
public function auth($name = '')
{
$this->headers([
'WWW-Authenticate: Basic realm="' . $name . '"',
@@ -62,22 +60,23 @@ class Response
return $this;
}
public function cache(string $eTag, int $lastModifiedTime = 2592000): self
public function cache($eTag, $lastModified = 2592000)
{
$this->headers([
'Cache-Control: public',
sprintf('Last-Modified: %s GMT', gmdate('D, d M Y H:i:s', $lastModifiedTime)),
sprintf('Etag: %s', $eTag),
'Last-Modified: ' . gmdate('D, d M Y H:i:s', $lastModified) . ' GMT',
'Etag: ' . $eTag,
]);
$httpModified = $this->request->getHeader('http-if-modified-since');
$httpIfNoneMatch = $this->request->getHeader('http-if-none-match');
if (($httpIfNoneMatch !== null && $httpIfNoneMatch === $eTag) || ($httpModified !== null && strtotime($httpModified) === $lastModifiedTime)) {
if (($httpIfNoneMatch !== null && $httpIfNoneMatch === $eTag) || ($httpModified !== null && strtotime($httpModified) === $lastModified)) {
$this->header('HTTP/1.1 304 Not Modified');
exit(0);
exit();
}
return $this;
@@ -88,12 +87,12 @@ class Response
* @param array|\JsonSerializable $value
* @param int $options JSON options Bitmask consisting of JSON_HEX_QUOT, JSON_HEX_TAG, JSON_HEX_AMP, JSON_HEX_APOS, JSON_NUMERIC_CHECK, JSON_PRETTY_PRINT, JSON_UNESCAPED_SLASHES, JSON_FORCE_OBJECT, JSON_PRESERVE_ZERO_FRACTION, JSON_UNESCAPED_UNICODE, JSON_PARTIAL_OUTPUT_ON_ERROR.
* @param int $dept JSON debt.
* @throws InvalidArgumentException
* @throws \InvalidArgumentException
*/
public function json($value, ?int $options = null, int $dept = 512): void
public function json($value, $options = null, $dept = 512)
{
if (($value instanceof \JsonSerializable) === false && \is_array($value) === false) {
throw new InvalidArgumentException('Invalid type for parameter "value". Must be of type array or object implementing the \JsonSerializable interface.');
if (($value instanceof \JsonSerializable) === false && is_array($value) === false) {
throw new \InvalidArgumentException('Invalid type for parameter "value". Must be of type array or object implementing the \JsonSerializable interface.');
}
$this->header('Content-Type: application/json; charset=utf-8');
@@ -106,7 +105,7 @@ class Response
* @param string $value
* @return static
*/
public function header(string $value): self
public function header($value)
{
header($value);
@@ -118,7 +117,7 @@ class Response
* @param array $headers
* @return static
*/
public function headers(array $headers): self
public function headers(array $headers)
{
foreach ($headers as $header) {
$this->header($header);
+24 -23
View File
@@ -2,19 +2,13 @@
namespace Pecee\Http\Security;
use Pecee\Http\Security\Exceptions\SecurityException;
class CookieTokenProvider implements ITokenProvider
{
public const CSRF_KEY = 'CSRF-TOKEN';
const CSRF_KEY = 'CSRF-TOKEN';
protected $token;
protected $cookieTimeoutMinutes = 120;
/**
* CookieTokenProvider constructor.
* @throws SecurityException
*/
public function __construct()
{
$this->token = $this->getToken();
@@ -27,16 +21,23 @@ class CookieTokenProvider implements ITokenProvider
/**
* Generate random identifier for CSRF token
*
* @throws \RuntimeException|\Exception
* @return string
* @throws SecurityException
*/
public function generateToken(): string
public function generateToken()
{
try {
if (function_exists('random_bytes') === true) {
return bin2hex(random_bytes(32));
} catch (\Exception $e) {
throw new SecurityException($e->getMessage(), (int)$e->getCode(), $e->getPrevious());
}
$isSourceStrong = false;
$random = openssl_random_pseudo_bytes(32, $isSourceStrong);
if ($isSourceStrong === false || $random === false) {
throw new \RuntimeException('IV generation failed');
}
return $random;
}
/**
@@ -45,9 +46,9 @@ class CookieTokenProvider implements ITokenProvider
* @param string $token
* @return bool
*/
public function validate(string $token): bool
public function validate($token)
{
if ($this->getToken() !== null) {
if ($token !== null && $this->getToken() !== null) {
return hash_equals($token, $this->getToken());
}
@@ -60,10 +61,10 @@ class CookieTokenProvider implements ITokenProvider
*
* @param string $token
*/
public function setToken(string $token): void
public function setToken($token)
{
$this->token = $token;
setcookie(static::CSRF_KEY, $token, (int)((time() + 60) * $this->cookieTimeoutMinutes), '/', ini_get('session.cookie_domain'), ini_get('session.cookie_secure'), ini_get('session.cookie_httponly'));
setcookie(static::CSRF_KEY, $token, time() + 60 * $this->cookieTimeoutMinutes, '/');
}
/**
@@ -71,17 +72,17 @@ class CookieTokenProvider implements ITokenProvider
* @param string|null $defaultValue
* @return string|null
*/
public function getToken(?string $defaultValue = null): ?string
public function getToken($defaultValue = null)
{
$this->token = ($this->hasToken() === true) ? $_COOKIE[static::CSRF_KEY] : null;
return $this->token ?? $defaultValue;
return ($this->token !== null) ? $this->token : $defaultValue;
}
/**
* Refresh existing token
*/
public function refresh(): void
public function refresh()
{
if ($this->token !== null) {
$this->setToken($this->token);
@@ -92,7 +93,7 @@ class CookieTokenProvider implements ITokenProvider
* Returns whether the csrf token has been defined
* @return bool
*/
public function hasToken(): bool
public function hasToken()
{
return isset($_COOKIE[static::CSRF_KEY]);
}
@@ -101,16 +102,16 @@ class CookieTokenProvider implements ITokenProvider
* Get timeout for cookie in minutes
* @return int
*/
public function getCookieTimeoutMinutes(): int
public function getCookieTimeoutMinutes()
{
return $this->cookieTimeoutMinutes;
}
/**
* Set cookie timeout in minutes
* @param int $minutes
* @param $minutes
*/
public function setCookieTimeoutMinutes(int $minutes): void
public function setCookieTimeoutMinutes($minutes)
{
$this->cookieTimeoutMinutes = $minutes;
}
@@ -1,8 +0,0 @@
<?php
namespace Pecee\Http\Security\Exceptions;
class SecurityException extends \Exception
{
}
+2 -10
View File
@@ -8,7 +8,7 @@ interface ITokenProvider
/**
* Refresh existing token
*/
public function refresh(): void;
public function refresh();
/**
* Validate valid CSRF token
@@ -16,14 +16,6 @@ interface ITokenProvider
* @param string $token
* @return bool
*/
public function validate(string $token): bool;
/**
* Get token token
*
* @param string|null $defaultValue
* @return string|null
*/
public function getToken(?string $defaultValue = null): ?string;
public function validate($token);
}
+168
View File
@@ -0,0 +1,168 @@
<?php
namespace Pecee\Http;
class Uri
{
private $originalUrl;
private $data = [
'scheme' => null,
'host' => null,
'port' => null,
'user' => null,
'pass' => null,
'path' => null,
'query' => null,
'fragment' => null,
];
public function __construct($url)
{
$this->originalUrl = $url;
$this->data = $this->parseUrl($url) + $this->data;
if (isset($this->data['path']) === true && $this->data['path'] !== '/') {
$this->data['path'] = rtrim($this->data['path'], '/') . '/';
}
}
/**
* Check if url is using a secure protocol like https
* @return bool
*/
public function isSecure()
{
return (strtolower($this->getScheme()) === 'https');
}
/**
* Checks if url is relative
* @return bool
*/
public function isRelative()
{
return ($this->getHost() === null);
}
/**
* Get url scheme
* @return string|null
*/
public function getScheme()
{
return $this->data['scheme'];
}
/**
* Get url host
* @return string|null
*/
public function getHost()
{
return $this->data['host'];
}
/**
* Get url port
* @return int|null
*/
public function getPort()
{
return ($this->data['port'] !== null) ? (int)$this->data['port'] : null;
}
/**
* Parse username from url
* @return string|null
*/
public function getUserName()
{
return $this->data['user'];
}
/**
* Parse password from url
* @return string|null
*/
public function getPassword()
{
return $this->data['pass'];
}
/**
* Get path from url
* @return string
*/
public function getPath()
{
return $this->data['path'];
}
/**
* Get querystring from url
* @return string|null
*/
public function getQueryString()
{
return $this->data['query'];
}
/**
* Get fragment from url (everything after #)
* @return string|null
*/
public function getFragment()
{
return $this->data['fragment'];
}
/**
* @return string
*/
public function getOriginalUrl()
{
return $this->originalUrl;
}
/**
* UTF-8 aware parse_url() replacement.
* @param string $url
* @param int $component
* @throws \InvalidArgumentException
* @return array
*/
public function parseUrl($url, $component = -1)
{
$encodedUrl = preg_replace_callback(
'/[^:\/@?&=#]+/u',
function ($matches) {
return urlencode($matches[0]);
},
$url
);
$parts = parse_url($encodedUrl, $component);
if ($parts === false) {
throw new \InvalidArgumentException('Malformed URL: ' . $url);
}
return array_map('urldecode', $parts);
}
/**
* Returns data array with information about the url
* @return array
*/
public function getData()
{
return $this->data;
}
public function __toString()
{
return $this->getOriginalUrl();
}
}
-449
View File
@@ -1,449 +0,0 @@
<?php
namespace Pecee\Http;
use Pecee\Http\Exceptions\MalformedUrlException;
class Url
{
private $originalUrl;
private $scheme;
private $host;
private $port;
private $username;
private $password;
private $path;
private $params;
private $fragment;
/**
* Url constructor.
*
* @param string $url
* @throws MalformedUrlException
*/
public function __construct(?string $url)
{
$this->originalUrl = $url;
if ($url !== null && $url !== '/') {
$data = $this->parseUrl($url);
$this->scheme = $data['scheme'] ?? null;
$this->host = $data['host'] ?? null;
$this->port = $data['port'] ?? null;
$this->username = $data['user'] ?? null;
$this->password = $data['pass'] ?? null;
if (isset($data['path']) === true) {
$this->setPath($data['path']);
}
$this->fragment = $data['fragment'] ?? null;
if (isset($data['query']) === true) {
$params = [];
parse_str($data['query'], $params);
$this->setParams($params);
}
}
}
/**
* Check if url is using a secure protocol like https
*
* @return bool
*/
public function isSecure(): bool
{
return (strtolower($this->getScheme()) === 'https');
}
/**
* Checks if url is relative
*
* @return bool
*/
public function isRelative(): bool
{
return ($this->getHost() === null);
}
/**
* Get url scheme
*
* @return string|null
*/
public function getScheme(): ?string
{
return $this->scheme;
}
/**
* Set the scheme of the url
*
* @param string $scheme
* @return static
*/
public function setScheme(string $scheme): self
{
$this->scheme = $scheme;
return $this;
}
/**
* Get url host
*
* @return string|null
*/
public function getHost(): ?string
{
return $this->host;
}
/**
* Set the host of the url
*
* @param string $host
* @return static
*/
public function setHost(string $host): self
{
$this->host = $host;
return $this;
}
/**
* Get url port
*
* @return int|null
*/
public function getPort(): ?int
{
return ($this->port !== null) ? (int)$this->port : null;
}
/**
* Set the port of the url
*
* @param int $port
* @return static
*/
public function setPort(int $port): self
{
$this->port = $port;
return $this;
}
/**
* Parse username from url
*
* @return string|null
*/
public function getUsername(): ?string
{
return $this->username;
}
/**
* Set the username of the url
*
* @param string $username
* @return static
*/
public function setUsername(string $username): self
{
$this->username = $username;
return $this;
}
/**
* Parse password from url
* @return string|null
*/
public function getPassword(): ?string
{
return $this->password;
}
/**
* Set the url password
*
* @param string $password
* @return static
*/
public function setPassword(string $password): self
{
$this->password = $password;
return $this;
}
/**
* Get path from url
* @return string
*/
public function getPath(): ?string
{
return $this->path ?? '/';
}
/**
* Set the url path
*
* @param string $path
* @return static
*/
public function setPath(string $path): self
{
$this->path = rtrim($path, '/') . '/';
return $this;
}
/**
* Get query-string from url
*
* @return array
*/
public function getParams(): array
{
return $this->params;
}
/**
* Merge parameters array
*
* @param array $params
* @return static
*/
public function mergeParams(array $params): self
{
return $this->setParams(array_merge($this->getParams(), $params));
}
/**
* Set the url params
*
* @param array $params
* @return static
*/
public function setParams(array $params): self
{
$this->params = $params;
return $this;
}
/**
* Get query-string params as string
*
* @return string
*/
public function getQueryString(): string
{
return static::arrayToParams($this->getParams());
}
/**
* Get fragment from url (everything after #)
*
* @return string|null
*/
public function getFragment(): ?string
{
return $this->fragment;
}
/**
* Set url fragment
*
* @param string $fragment
* @return static
*/
public function setFragment(string $fragment): self
{
$this->fragment = $fragment;
return $this;
}
/**
* @return string
*/
public function getOriginalUrl(): string
{
return $this->originalUrl;
}
/**
* Get position of value.
* Returns -1 on failure.
*
* @param string $value
* @return int
*/
public function indexOf(string $value): int
{
$index = stripos($this->getOriginalUrl(), $value);
return ($index === false) ? -1 : $index;
}
/**
* Check if url contains value.
*
* @param string $value
* @return bool
*/
public function contains(string $value): bool
{
return (stripos($this->getOriginalUrl(), $value) !== false);
}
/**
* Check if url contains parameter/query string.
*
* @param string $name
* @return bool
*/
public function hasParam(string $name): bool
{
return \in_array($name, $this->getParams(), true);
}
/**
* Removes parameter from query-string
*
* @param string $name
*/
public function removeParam(string $name): void
{
if ($this->hasParam($name) === true) {
$params = $this->getParams();
$key = \array_search($name, $params, true);
if ($key === true) {
unset($params[$key]);
$this->setParams($params);
}
}
}
/**
* Get parameter by name.
* Returns parameter value or default value.
*
* @param string $name
* @param string|null $defaultValue
* @return string|null
*/
public function getParam(string $name, ?string $defaultValue = null): ?string
{
$output = null;
if ($this->hasParam($name) === true) {
$params = $this->getParams();
$key = \array_search($name, $params, true);
if ($key === true) {
$output = $params[$key];
}
}
return $output ?? $defaultValue;
}
/**
* UTF-8 aware parse_url() replacement.
* @param string $url
* @param int $component
* @return array
* @throws MalformedUrlException
*/
public function parseUrl(string $url, int $component = -1): array
{
$encodedUrl = preg_replace_callback(
'/[^:\/@?&=#]+/u',
function ($matches) {
return urlencode($matches[0]);
},
$url
);
$parts = parse_url($encodedUrl, $component);
if ($parts === false) {
throw new MalformedUrlException(sprintf('Failed to parse url: "%s"', $url));
}
return array_map('urldecode', $parts);
}
/**
* Convert array to query-string params
*
* @param array $getParams
* @param bool $includeEmpty
* @return string
*/
public static function arrayToParams(array $getParams = [], bool $includeEmpty = true): string
{
if (\count($getParams) !== 0) {
if ($includeEmpty === false) {
$getParams = array_filter($getParams, function ($item) {
return (trim($item) !== '');
});
}
return http_build_query($getParams);
}
return '';
}
/**
* Returns the relative url
*
* @return string
*/
public function getRelativeUrl(): string
{
$params = $this->getQueryString();
$path = $this->path ?? '';
$query = $params !== '' ? '?' . $params : '';
$fragment = $this->fragment !== null ? '#' . $this->fragment : '';
return $path . $query . $fragment;
}
/**
* Returns the absolute url
*
* @return string
*/
public function getAbsoluteUrl(): string
{
$scheme = $this->scheme !== null ? $this->scheme . '://' : '';
$host = $this->host ?? '';
$port = $this->port !== null ? ':' . $this->port : '';
$user = $this->username ?? '';
$pass = $this->password !== null ? ':' . $this->password : '';
$pass = ($user || $pass) ? $pass . '@' : '';
return $scheme . $user . $pass . $host . $port . $this->getRelativeUrl();
}
public function __toString()
{
return $this->getRelativeUrl();
}
}
@@ -1,118 +0,0 @@
<?php
namespace Pecee\SimpleRouter\ClassLoader;
use DI\Container;
use Pecee\SimpleRouter\Exceptions\NotFoundHttpException;
class ClassLoader implements IClassLoader
{
/**
* Dependency injection enabled
* @var bool
*/
protected $useDependencyInjection = false;
/**
* @var Container|null
*/
protected $container;
/**
* Load class
*
* @param string $class
* @return mixed
* @throws NotFoundHttpException
*/
public function loadClass(string $class)
{
if (class_exists($class) === false) {
throw new NotFoundHttpException(sprintf('Class "%s" does not exist', $class), 404);
}
if ($this->useDependencyInjection === true) {
$container = $this->getContainer();
if ($container !== null) {
try {
return $container->get($class);
} catch (\Exception $e) {
throw new NotFoundHttpException($e->getMessage(), (int)$e->getCode(), $e->getPrevious());
}
}
}
return new $class();
}
/**
* Load closure
*
* @param \Closure $closure
* @param array $parameters
* @return mixed
* @throws NotFoundHttpException
*/
public function loadClosure(\Closure $closure, array $parameters)
{
if ($this->useDependencyInjection === true) {
$container = $this->getContainer();
if ($container !== null) {
try {
return $container->call($closure, $parameters);
} catch (\Exception $e) {
throw new NotFoundHttpException($e->getMessage(), (int)$e->getCode(), $e->getPrevious());
}
}
}
return \call_user_func_array($closure, $parameters);
}
/**
* Get dependency injector container.
*
* @return Container|null
*/
public function getContainer(): ?Container
{
return $this->container;
}
/**
* Set the dependency-injector container.
*
* @param Container $container
* @return ClassLoader
*/
public function setContainer(Container $container): self
{
$this->container = $container;
return $this;
}
/**
* Enable or disable dependency injection.
*
* @param bool $enabled
* @return static
*/
public function useDependencyInjection(bool $enabled): self
{
$this->useDependencyInjection = $enabled;
return $this;
}
/**
* Return true if dependency injection is enabled.
*
* @return bool
*/
public function isDependencyInjectionEnabled(): bool
{
return $this->useDependencyInjection;
}
}
@@ -1,12 +0,0 @@
<?php
namespace Pecee\SimpleRouter\ClassLoader;
interface IClassLoader
{
public function loadClass(string $class);
public function loadClosure(\Closure $closure, array $parameters);
}
@@ -1,111 +0,0 @@
<?php
namespace Pecee\SimpleRouter\Event;
use Pecee\Http\Request;
use Pecee\SimpleRouter\Router;
class EventArgument implements IEventArgument
{
/**
* Event name
* @var string
*/
protected $eventName;
/**
* @var Router
*/
protected $router;
/**
* @var array
*/
protected $arguments = [];
public function __construct($eventName, $router, array $arguments = [])
{
$this->eventName = $eventName;
$this->router = $router;
$this->arguments = $arguments;
}
/**
* Get event name
*
* @return string
*/
public function getEventName(): string
{
return $this->eventName;
}
/**
* Set the event name
*
* @param string $name
*/
public function setEventName(string $name): void
{
$this->eventName = $name;
}
/**
* Get the router instance
*
* @return Router
*/
public function getRouter(): Router
{
return $this->router;
}
/**
* Get the request instance
*
* @return Request
*/
public function getRequest(): Request
{
return $this->getRouter()->getRequest();
}
/**
* @param string $name
* @return mixed
*/
public function __get($name)
{
return $this->arguments[$name] ?? null;
}
/**
* @param string $name
* @return bool
*/
public function __isset($name)
{
return array_key_exists($name, $this->arguments);
}
/**
* @param string $name
* @param mixed $value
* @throws \InvalidArgumentException
*/
public function __set($name, $value)
{
throw new \InvalidArgumentException('Not supported');
}
/**
* Get arguments
*
* @return array
*/
public function getArguments(): array
{
return $this->arguments;
}
}
@@ -1,46 +0,0 @@
<?php
namespace Pecee\SimpleRouter\Event;
use Pecee\Http\Request;
use Pecee\SimpleRouter\Router;
interface IEventArgument
{
/**
* Get event name
*
* @return string
*/
public function getEventName(): string;
/**
* Set event name
*
* @param string $name
*/
public function setEventName(string $name): void;
/**
* Get router instance
*
* @return Router
*/
public function getRouter(): Router;
/**
* Get request instance
*
* @return Request
*/
public function getRequest(): Request;
/**
* Get all event arguments
*
* @return array
*/
public function getArguments(): array;
}
@@ -1,5 +1,4 @@
<?php
namespace Pecee\SimpleRouter\Exceptions;
class HttpException extends \Exception
@@ -1,5 +1,4 @@
<?php
namespace Pecee\SimpleRouter\Exceptions;
class NotFoundHttpException extends HttpException
@@ -1,62 +0,0 @@
<?php
namespace Pecee\SimpleRouter\Handlers;
use Pecee\SimpleRouter\Event\EventArgument;
use Pecee\SimpleRouter\Router;
class DebugEventHandler implements IEventHandler
{
/**
* Debug callback
* @var \Closure
*/
protected $callback;
public function __construct()
{
$this->callback = function (EventArgument $argument) {
// todo: log in database
};
}
/**
* Get events.
*
* @param string|null $name Filter events by name.
* @return array
*/
public function getEvents(?string $name): array
{
return [
$name => [
$this->callback,
],
];
}
/**
* Fires any events registered with given event-name
*
* @param Router $router Router instance
* @param string $name Event name
* @param array $eventArgs Event arguments
*/
public function fireEvents(Router $router, string $name, array $eventArgs = []): void
{
$callback = $this->callback;
$callback(new EventArgument($router, $eventArgs));
}
/**
* Set debug callback
*
* @param \Closure $event
*/
public function setCallback(\Closure $event): void
{
$this->callback = $event;
}
}
@@ -1,178 +0,0 @@
<?php
namespace Pecee\SimpleRouter\Handlers;
use Pecee\SimpleRouter\Event\EventArgument;
use Pecee\SimpleRouter\Router;
class EventHandler implements IEventHandler
{
/**
* Fires when a event is triggered.
*/
public const EVENT_ALL = '*';
/**
* Fires when router is initializing and before routes are loaded.
*/
public const EVENT_INIT = 'onInit';
/**
* Fires when all routes has been loaded and rendered, just before the output is returned.
*/
public const EVENT_LOAD = 'onLoad';
/**
* Fires when a url-rewrite is and just before the routes are re-initialized.
*/
public const EVENT_REWRITE = 'onRewrite';
/**
* Fires when the router is booting.
* This happens just before boot-managers are rendered and before any routes has been loaded.
*/
public const EVENT_BOOT = 'onBoot';
/**
* Fires before a boot-manager is rendered.
*/
public const EVENT_RENDER_BOOTMANAGER = 'onRenderBootManager';
/**
* Fires when the router is about to load all routes.
*/
public const EVENT_LOAD_ROUTES = 'onLoadRoutes';
/**
* Fires whenever the `findRoute` method is called within the `Router`.
* This usually happens when the router tries to find routes that
* contains a certain url, usually after the EventHandler::EVENT_GET_URL event.
*/
public const EVENT_FIND_ROUTE = 'onFindRoute';
/**
* Fires whenever the `Router::getUrl` method or `url`-helper function
* is called and the router tries to find the route.
*/
public const EVENT_GET_URL = 'onGetUrl';
/**
* Fires when a route is matched and valid (correct request-type etc).
* and before the route is rendered.
*/
public const EVENT_MATCH_ROUTE = 'onMatchRoute';
/**
* Fires before a route is rendered.
*/
public const EVENT_RENDER_ROUTE = 'onRenderRoute';
/**
* Fires when the router is loading exception-handlers.
*/
public const EVENT_LOAD_EXCEPTIONS = 'onLoadExceptions';
/**
* Fires before the router is rendering a exception-handler.
*/
public const EVENT_RENDER_EXCEPTION = 'onRenderException';
/**
* Fires before a middleware is rendered.
*/
public const EVENT_RENDER_MIDDLEWARES = 'onRenderMiddlewares';
/**
* Fires before the CSRF-verifier is rendered.
*/
public const EVENT_RENDER_CSRF = 'onRenderCsrfVerifier';
/**
* All available events
* @var array
*/
public static $events = [
self::EVENT_ALL,
self::EVENT_INIT,
self::EVENT_LOAD,
self::EVENT_REWRITE,
self::EVENT_BOOT,
self::EVENT_RENDER_BOOTMANAGER,
self::EVENT_LOAD_ROUTES,
self::EVENT_FIND_ROUTE,
self::EVENT_GET_URL,
self::EVENT_MATCH_ROUTE,
self::EVENT_RENDER_ROUTE,
self::EVENT_LOAD_EXCEPTIONS,
self::EVENT_RENDER_EXCEPTION,
self::EVENT_RENDER_MIDDLEWARES,
self::EVENT_RENDER_CSRF,
];
/**
* List of all registered events
* @var array
*/
private $registeredEvents = [];
/**
* Register new event
*
* @param string $name
* @param \Closure $callback
* @return static
*/
public function register(string $name, \Closure $callback): IEventHandler
{
if (isset($this->registeredEvents[$name]) === true) {
$this->registeredEvents[$name][] = $callback;
} else {
$this->registeredEvents[$name] = [$callback];
}
return $this;
}
/**
* Get events.
*
* @param string|null $name Filter events by name.
* @param array ...$names Add multiple names...
* @return array
*/
public function getEvents(?string $name, ...$names): array
{
if ($name === null) {
return $this->registeredEvents;
}
$names[] = $name;
$events = [];
foreach ($names as $eventName) {
if (isset($this->registeredEvents[$eventName]) === true) {
$events += $this->registeredEvents[$eventName];
}
}
return $events;
}
/**
* Fires any events registered with given event-name
*
* @param Router $router Router instance
* @param string $name Event name
* @param array $eventArgs Event arguments
*/
public function fireEvents(Router $router, string $name, array $eventArgs = []): void
{
$events = $this->getEvents(static::EVENT_ALL, $name);
/* @var $event \Closure */
foreach ($events as $event) {
$event(new EventArgument($name, $router, $eventArgs));
}
}
}
@@ -1,27 +0,0 @@
<?php
namespace Pecee\SimpleRouter\Handlers;
use Pecee\SimpleRouter\Router;
interface IEventHandler
{
/**
* Get events.
*
* @param string|null $name Filter events by name.
* @return array
*/
public function getEvents(?string $name): array;
/**
* Fires any events registered with given event-name
*
* @param Router $router Router instance
* @param string $name Event name
* @param array $eventArgs Event arguments
*/
public function fireEvents(Router $router, string $name, array $eventArgs = []): void;
}
@@ -1,5 +1,4 @@
<?php
namespace Pecee\SimpleRouter;
use Pecee\Http\Request;
@@ -9,8 +8,8 @@ interface IRouterBootManager
/**
* Called when router loads it's routes
*
* @param Router $router
* @param Request $request
* @return Request
*/
public function boot(Router $router, Request $request): void;
public function boot(Request $request);
}
@@ -1,5 +1,4 @@
<?php
namespace Pecee\SimpleRouter\Route;
interface IControllerRoute extends IRoute
@@ -9,7 +8,7 @@ interface IControllerRoute extends IRoute
*
* @return string
*/
public function getController(): string;
public function getController();
/**
* Set controller class-name
@@ -17,6 +16,21 @@ interface IControllerRoute extends IRoute
* @param string $controller
* @return static
*/
public function setController(string $controller): self;
public function setController($controller);
/**
* Return active method
*
* @return string
*/
public function getMethod();
/**
* Set active method
*
* @param string $method
* @return static
*/
public function setMethod($method);
}
+13 -13
View File
@@ -2,8 +2,8 @@
namespace Pecee\SimpleRouter\Route;
use Pecee\Handlers\IExceptionHandler;
use Pecee\Http\Request;
use Pecee\SimpleRouter\Handlers\IExceptionHandler;
interface IGroupRoute extends IRoute
{
@@ -13,21 +13,21 @@ interface IGroupRoute extends IRoute
* @param Request $request
* @return bool
*/
public function matchDomain(Request $request): bool;
public function matchDomain(Request $request);
/**
* Add exception handler
*
* @param IExceptionHandler|string $handler
* @return static
* @return static $this;
*/
public function addExceptionHandler($handler): self;
public function addExceptionHandler($handler);
/**
* Set exception-handlers for group
*
* @param array $handlers
* @return static
* @return static $this
*/
public function setExceptionHandlers(array $handlers);
@@ -36,35 +36,35 @@ interface IGroupRoute extends IRoute
*
* @return array
*/
public function getExceptionHandlers(): array;
public function getExceptionHandlers();
/**
* Get domains for domain.
*
* @return array
*/
public function getDomains(): array;
public function getDomains();
/**
* Set allowed domains for group.
*
* @param array $domains
* @return static
* @return $this
*/
public function setDomains(array $domains): self;
public function setDomains(array $domains);
/**
* Set prefix that child-routes will inherit.
*
* @param string $prefix
* @return static
* @return string
*/
public function setPrefix($prefix): self;
public function setPrefix($prefix);
/**
* Get prefix.
*
* @return string|null
* @return string
*/
public function getPrefix(): ?string;
public function getPrefix();
}
+13 -25
View File
@@ -1,9 +1,7 @@
<?php
namespace Pecee\SimpleRouter\Route;
use Pecee\Http\Request;
use Pecee\SimpleRouter\Router;
interface ILoadableRoute extends IRoute
{
@@ -12,39 +10,29 @@ interface ILoadableRoute extends IRoute
* Used when calling the url() helper.
*
* @param string|null $method
* @param array|string|null $parameters
* @param array|null $parameters
* @param string|null $name
* @return string
*/
public function findUrl(?string $method = null, $parameters = null, ?string $name = null): string;
public function findUrl($method = null, $parameters = null, $name = null);
/**
* Loads and renders middleware-classes
* Loads and renders middlewares-classes
*
* @param Request $request
* @param Router $router
*/
public function loadMiddleware(Request $request, Router $router): void;
public function loadMiddleware(Request $request);
/**
* Get url
* @return string
*/
public function getUrl(): string;
public function getUrl();
/**
* Set url
* @param string $url
* @return static
*/
public function setUrl(string $url): self;
public function setUrl($url);
/**
* Returns the provided name for the router.
*
* @return string|null
* @return string
*/
public function getName(): ?string;
public function getName();
/**
* Check if route has given name.
@@ -52,22 +40,22 @@ interface ILoadableRoute extends IRoute
* @param string $name
* @return bool
*/
public function hasName(string $name): bool;
public function hasName($name);
/**
* Sets the router name, which makes it easier to obtain the url or router at a later point.
*
* @param string $name
* @return static
* @return static $this
*/
public function setName(string $name): self;
public function setName($name);
/**
* Get regular expression match used for matching route (if defined).
*
* @return string
*/
public function getMatch(): ?string;
public function getMatch();
/**
* Add regular expression match for the entire route.
@@ -75,6 +63,6 @@ interface ILoadableRoute extends IRoute
* @param string $regex
* @return static
*/
public function setMatch($regex): self;
public function setMatch($regex);
}
+36 -58
View File
@@ -3,7 +3,6 @@
namespace Pecee\SimpleRouter\Route;
use Pecee\Http\Request;
use Pecee\SimpleRouter\Router;
interface IRoute
{
@@ -14,18 +13,17 @@ interface IRoute
* @param Request $request
* @return bool
*/
public function matchRoute($route, Request $request): bool;
public function matchRoute($route, Request $request);
/**
* Called when route is matched.
* Returns class to be rendered.
*
* @param Request $request
* @param Router $router
* @throws \Pecee\SimpleRouter\Exceptions\NotFoundHttpException
* @return string
*/
public function renderRoute(Request $request, Router $router): ?string;
public function renderRoute(Request $request);
/**
* Returns callback name/identifier for the current route based on the callback.
@@ -34,50 +32,50 @@ interface IRoute
*
* @return string
*/
public function getIdentifier(): string;
public function getIdentifier();
/**
* Set allowed request methods
*
* @param array $methods
* @return static
* @return static $this
*/
public function setRequestMethods(array $methods): self;
public function setRequestMethods(array $methods);
/**
* Get allowed request methods
*
* @return array
*/
public function getRequestMethods(): array;
public function getRequestMethods();
/**
* @return IRoute|null
*/
public function getParent(): ?IRoute;
public function getParent();
/**
* Get the group for the route.
*
* @return IGroupRoute|null
*/
public function getGroup(): ?IGroupRoute;
public function getGroup();
/**
* Set group
*
* @param IGroupRoute $group
* @return static
* @return static $this
*/
public function setGroup(IGroupRoute $group): self;
public function setGroup(IGroupRoute $group);
/**
* Set parent route
*
* @param IRoute $parent
* @return static
* @return static $this
*/
public function setParent(IRoute $parent): self;
public function setParent(IRoute $parent);
/**
* Set callback
@@ -85,64 +83,44 @@ interface IRoute
* @param string $callback
* @return static
*/
public function setCallback($callback): self;
public function setCallback($callback);
/**
* @return string|callable
* @return string
*/
public function getCallback();
/**
* Return active method
*
* @return string|null
*/
public function getMethod(): ?string;
public function getMethod();
/**
* Set active method
*
* @param string $method
* @return static
*/
public function setMethod(string $method): self;
public function getClass();
/**
* Get class
*
* @return string|null
*/
public function getClass(): ?string;
public function setMethod($method);
/**
* @param string $namespace
* @return static
* @return static $this
*/
public function setNamespace(string $namespace): self;
public function setNamespace($namespace);
/**
* @return string|null
* @return string
*/
public function getNamespace(): ?string;
public function getNamespace();
/**
* @param string $namespace
* @return static
* @return static $this
*/
public function setDefaultNamespace($namespace): IRoute;
public function setDefaultNamespace($namespace);
/**
* Get default namespace
* @return string|null
*/
public function getDefaultNamespace(): ?string;
public function getDefaultNamespace();
/**
* Get parameter names.
*
* @return array
*/
public function getWhere(): array;
public function getWhere();
/**
* Set parameter names.
@@ -150,45 +128,45 @@ interface IRoute
* @param array $options
* @return static
*/
public function setWhere(array $options): self;
public function setWhere(array $options);
/**
* Get parameters
*
* @return array
*/
public function getParameters(): array;
public function getParameters();
/**
* Get parameters
*
* @param array $parameters
* @return static
* @return static $this
*/
public function setParameters(array $parameters): self;
public function setParameters(array $parameters);
/**
* Merge with information from another route.
*
* @param array $settings
* @param bool $merge
* @return static
* @return static $this
*/
public function setSettings(array $settings, bool $merge = false): self;
public function setSettings(array $settings, $merge = false);
/**
* Export route settings to array so they can be merged with another route.
*
* @return array
*/
public function toArray(): array;
public function toArray();
/**
* Get middlewares array
*
* @return array
*/
public function getMiddlewares(): array;
public function getMiddlewares();
/**
* Set middleware class-name
@@ -196,14 +174,14 @@ interface IRoute
* @param string $middleware
* @return static
*/
public function addMiddleware($middleware): self;
public function addMiddleware($middleware);
/**
* Set middlewares array
*
* @param array $middlewares
* @return static
* @return $this
*/
public function setMiddlewares(array $middlewares): self;
public function setMiddlewares(array $middlewares);
}
+26 -32
View File
@@ -5,7 +5,6 @@ namespace Pecee\SimpleRouter\Route;
use Pecee\Http\Middleware\IMiddleware;
use Pecee\Http\Request;
use Pecee\SimpleRouter\Exceptions\HttpException;
use Pecee\SimpleRouter\Router;
abstract class LoadableRoute extends Route implements ILoadableRoute
{
@@ -25,34 +24,25 @@ abstract class LoadableRoute extends Route implements ILoadableRoute
* Loads and renders middlewares-classes
*
* @param Request $request
* @param Router $router
* @throws HttpException
*/
public function loadMiddleware(Request $request, Router $router): void
public function loadMiddleware(Request $request)
{
$router->debug('Loading middlewares');
foreach ($this->getMiddlewares() as $middleware) {
if (\is_object($middleware) === false) {
$middleware = $router->getClassLoader()->loadClass($middleware);
if (is_object($middleware) === false) {
$middleware = $this->loadClass($middleware);
}
if (($middleware instanceof IMiddleware) === false) {
throw new HttpException($middleware . ' must be inherit the IMiddleware interface');
}
$className = \get_class($middleware);
$router->debug('Loading middleware "%s"', $className);
$middleware->handle($request);
$router->debug('Finished loading middleware "%s"', $className);
}
$router->debug('Finished loading middlewares');
}
public function matchRegex(Request $request, $url): ?bool
public function matchRegex(Request $request, $url)
{
/* Match on custom defined regular expression */
@@ -60,7 +50,7 @@ abstract class LoadableRoute extends Route implements ILoadableRoute
return null;
}
return ((bool)preg_match($this->regex, $request->getHost() . $url) !== false);
return (preg_match($this->regex, $request->getHost() . $url) > 0);
}
/**
@@ -69,7 +59,7 @@ abstract class LoadableRoute extends Route implements ILoadableRoute
* @param string $url
* @return static
*/
public function setUrl(string $url): ILoadableRoute
public function setUrl($url)
{
$this->url = ($url === '/') ? '/' : '/' . trim($url, '/') . '/';
@@ -77,7 +67,7 @@ abstract class LoadableRoute extends Route implements ILoadableRoute
$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) {
if (preg_match_all('/' . $regex . '/u', $this->url, $matches) > 0) {
$this->parameters = array_fill_keys($matches[1], null);
}
}
@@ -85,7 +75,7 @@ abstract class LoadableRoute extends Route implements ILoadableRoute
return $this;
}
public function getUrl(): string
public function getUrl()
{
return $this->url;
}
@@ -99,13 +89,13 @@ abstract class LoadableRoute extends Route implements ILoadableRoute
* @param string|null $name
* @return string
*/
public function findUrl(?string $method = null, $parameters = null, ?string $name = null): string
public function findUrl($method = null, $parameters = null, $name = null)
{
$url = $this->getUrl();
$group = $this->getGroup();
if ($group !== null && \count($group->getDomains()) !== 0) {
if ($group !== null && count($group->getDomains()) !== 0) {
$url = '//' . $group->getDomains()[0] . $url;
}
@@ -121,10 +111,13 @@ abstract class LoadableRoute extends Route implements ILoadableRoute
/* Replace any {parameter} in the url with the correct value */
$params = $this->getParameters();
$max = count($params) - 1;
$keys = array_keys($params);
foreach (array_keys($params) as $param) {
for ($i = $max; $i >= 0; $i--) {
$param = $keys[$i];
if ($parameters === '' || (\is_array($parameters) === true && \count($parameters) === 0)) {
if ($parameters === '' || (is_array($parameters) === true && count($parameters) === 0)) {
$value = '';
} else {
$p = (array)$parameters;
@@ -144,7 +137,8 @@ abstract class LoadableRoute extends Route implements ILoadableRoute
}
}
$url = '/' . ltrim($url, '/') . implode('/', $unknownParams);
$url = '/' . ltrim($url, '/');
$url .= implode('/', $unknownParams);
return rtrim($url, '/') . '/';
}
@@ -154,7 +148,7 @@ abstract class LoadableRoute extends Route implements ILoadableRoute
*
* @return string
*/
public function getName(): string
public function getName()
{
return $this->name;
}
@@ -165,9 +159,9 @@ abstract class LoadableRoute extends Route implements ILoadableRoute
* @param string $name
* @return bool
*/
public function hasName(string $name): bool
public function hasName($name)
{
return strtolower($this->name) === strtolower($name);
return (strtolower($this->name) === strtolower($name));
}
/**
@@ -176,7 +170,7 @@ abstract class LoadableRoute extends Route implements ILoadableRoute
* @param string $regex
* @return static
*/
public function setMatch($regex): ILoadableRoute
public function setMatch($regex)
{
$this->regex = $regex;
@@ -188,7 +182,7 @@ abstract class LoadableRoute extends Route implements ILoadableRoute
*
* @return string
*/
public function getMatch(): string
public function getMatch()
{
return $this->regex;
}
@@ -201,7 +195,7 @@ abstract class LoadableRoute extends Route implements ILoadableRoute
* @param string|array $name
* @return static
*/
public function name($name): ILoadableRoute
public function name($name)
{
return $this->setName($name);
}
@@ -210,9 +204,9 @@ abstract class LoadableRoute extends Route implements ILoadableRoute
* Sets the router name, which makes it easier to obtain the url or router at a later point.
*
* @param string $name
* @return static
* @return static $this
*/
public function setName(string $name): ILoadableRoute
public function setName($name)
{
$this->name = $name;
@@ -226,7 +220,7 @@ abstract class LoadableRoute extends Route implements ILoadableRoute
* @param bool $merge
* @return static
*/
public function setSettings(array $values, bool $merge = false): IRoute
public function setSettings(array $values, $merge = false)
{
if (isset($values['as']) === true) {
+84 -83
View File
@@ -5,19 +5,18 @@ namespace Pecee\SimpleRouter\Route;
use Pecee\Http\Middleware\IMiddleware;
use Pecee\Http\Request;
use Pecee\SimpleRouter\Exceptions\NotFoundHttpException;
use Pecee\SimpleRouter\Router;
abstract class Route implements IRoute
{
protected const PARAMETERS_REGEX_FORMAT = '%s([\w]+)(\%s?)%s';
protected const PARAMETERS_DEFAULT_REGEX = '[\w]+';
const PARAMETERS_REGEX_FORMAT = '%s([\w]+)(\%s?)%s';
const PARAMETERS_DEFAULT_REGEX = '[\w]+';
public const REQUEST_TYPE_GET = 'get';
public const REQUEST_TYPE_POST = 'post';
public const REQUEST_TYPE_PUT = 'put';
public const REQUEST_TYPE_PATCH = 'patch';
public const REQUEST_TYPE_OPTIONS = 'options';
public const REQUEST_TYPE_DELETE = 'delete';
const REQUEST_TYPE_GET = 'get';
const REQUEST_TYPE_POST = 'post';
const REQUEST_TYPE_PUT = 'put';
const REQUEST_TYPE_PATCH = 'patch';
const REQUEST_TYPE_OPTIONS = 'options';
const REQUEST_TYPE_DELETE = 'delete';
public static $requestTypes = [
self::REQUEST_TYPE_GET,
@@ -57,29 +56,40 @@ abstract class Route implements IRoute
protected $originalParameters = [];
protected $middlewares = [];
/**
* Load class by name
* @param string $name
* @return mixed
* @throws NotFoundHttpException
*/
protected function loadClass($name)
{
if (class_exists($name) === false) {
throw new NotFoundHttpException(sprintf('Class "%s" does not exist', $name), 404);
}
return new $name();
}
/**
* Render route
*
* @param Request $request
* @param Router $router
* @return string|null
* @return string|mixed
* @throws NotFoundHttpException
*/
public function renderRoute(Request $request, Router $router): ?string
public function renderRoute(Request $request)
{
$router->debug('Starting rendering route "%s"', \get_class($this));
$callback = $this->getCallback();
if ($callback === null) {
return null;
}
$router->debug('Parsing parameters');
$parameters = $this->getParameters();
$router->debug('Finished parsing parameters');
/* Filter parameters with null-value */
if ($this->filterEmptyParams === true) {
$parameters = array_filter($parameters, function ($var) {
return ($var !== null);
@@ -87,12 +97,9 @@ abstract class Route implements IRoute
}
/* Render callback function */
if (\is_callable($callback) === true) {
$router->debug('Executing callback');
if (is_callable($callback) === true) {
/* When the callback is a function */
return $router->getClassLoader()->loadClosure($callback, $parameters);
return call_user_func_array($callback, $parameters);
}
/* When the callback is a class + method */
@@ -102,18 +109,14 @@ abstract class Route implements IRoute
$className = ($namespace !== null && $controller[0][0] !== '\\') ? $namespace . '\\' . $controller[0] : $controller[0];
$router->debug('Loading class %s', $className);
$class = $router->getClassLoader()->loadClass($className);
$class = $this->loadClass($className);
$method = $controller[1];
if (method_exists($class, $method) === false) {
throw new NotFoundHttpException(sprintf('Method "%s" does not exist in class "%s"', $method, $className), 404);
}
$router->debug('Executing callback');
return \call_user_func_array([$class, $method], $parameters);
return call_user_func_array([$class, $method], $parameters);
}
protected function parseParameters($route, $url, $parameterRegex = null)
@@ -122,12 +125,10 @@ abstract class Route implements IRoute
$parameters = [];
// Ensures that host names/domains will work with parameters
// Ensures that hostnames/domains will work with parameters
$url = '/' . ltrim($url, '/');
if ((bool)preg_match_all('/' . $regex . '/u', $route, $parameters) === false) {
$urlRegex = preg_quote($route, '/');
} else {
if (preg_match_all('/' . $regex . '/u', $route, $parameters) !== 0) {
$urlParts = preg_split('/((\-?\/?)\{[^}]+\})/', $route);
@@ -135,7 +136,7 @@ abstract class Route implements IRoute
$regex = '';
if ($key < \count($parameters[1])) {
if ($key < count($parameters[1])) {
$name = $parameters[1][$key];
@@ -148,11 +149,12 @@ abstract class Route implements IRoute
if ($parameterRegex !== null) {
$regex = $parameterRegex;
} else {
$regex = $this->defaultParameterRegex ?? static::PARAMETERS_DEFAULT_REGEX;
$regex = ($this->defaultParameterRegex === null) ? static::PARAMETERS_DEFAULT_REGEX : $this->defaultParameterRegex;
}
}
$regex = sprintf('(?:\/|\-)%1$s(?P<%2$s>%3$s)%1$s', $parameters[2][$key], $name, $regex);
}
$urlParts[$key] = preg_quote($t, '/') . $regex;
@@ -160,9 +162,11 @@ abstract class Route implements IRoute
$urlRegex = implode('', $urlParts);
} else {
$urlRegex = preg_quote($route, '/');
}
if ((bool)preg_match(sprintf($this->urlRegex, $urlRegex), $url, $matches) === false) {
if (preg_match(sprintf($this->urlRegex, $urlRegex), $url, $matches) === 0) {
return null;
}
@@ -186,9 +190,9 @@ abstract class Route implements IRoute
*
* @return string
*/
public function getIdentifier(): string
public function getIdentifier()
{
if (\is_string($this->callback) === true && strpos($this->callback, '@') !== false) {
if (is_string($this->callback) === true && strpos($this->callback, '@') !== false) {
return $this->callback;
}
@@ -199,9 +203,9 @@ abstract class Route implements IRoute
* Set allowed request methods
*
* @param array $methods
* @return static
* @return static $this
*/
public function setRequestMethods(array $methods): IRoute
public function setRequestMethods(array $methods)
{
$this->requestMethods = $methods;
@@ -213,7 +217,7 @@ abstract class Route implements IRoute
*
* @return array
*/
public function getRequestMethods(): array
public function getRequestMethods()
{
return $this->requestMethods;
}
@@ -221,7 +225,7 @@ abstract class Route implements IRoute
/**
* @return IRoute|null
*/
public function getParent(): ?IRoute
public function getParent()
{
return $this->parent;
}
@@ -231,7 +235,7 @@ abstract class Route implements IRoute
*
* @return IGroupRoute|null
*/
public function getGroup(): ?IGroupRoute
public function getGroup()
{
return $this->group;
}
@@ -240,15 +244,12 @@ abstract class Route implements IRoute
* Set group
*
* @param IGroupRoute $group
* @return static
* @return static $this
*/
public function setGroup(IGroupRoute $group): IRoute
public function setGroup(IGroupRoute $group)
{
$this->group = $group;
/* Add/merge parent settings with child */
$this->setSettings($group->toArray(), true);
return $this;
}
@@ -256,9 +257,9 @@ abstract class Route implements IRoute
* Set parent route
*
* @param IRoute $parent
* @return static
* @return static $this
*/
public function setParent(IRoute $parent): IRoute
public function setParent(IRoute $parent)
{
$this->parent = $parent;
@@ -271,7 +272,7 @@ abstract class Route implements IRoute
* @param string $callback
* @return static
*/
public function setCallback($callback): IRoute
public function setCallback($callback)
{
$this->callback = $callback;
@@ -279,16 +280,16 @@ abstract class Route implements IRoute
}
/**
* @return string|callable
* @return string
*/
public function getCallback()
{
return $this->callback;
}
public function getMethod(): ?string
public function getMethod()
{
if (\is_string($this->callback) === true && strpos($this->callback, '@') !== false) {
if (is_string($this->callback) === true && strpos($this->callback, '@') !== false) {
$tmp = explode('@', $this->callback);
return $tmp[1];
@@ -297,9 +298,9 @@ abstract class Route implements IRoute
return null;
}
public function getClass(): ?string
public function getClass()
{
if (\is_string($this->callback) === true && strpos($this->callback, '@') !== false) {
if (is_string($this->callback) === true && strpos($this->callback, '@') !== false) {
$tmp = explode('@', $this->callback);
return $tmp[0];
@@ -308,14 +309,14 @@ abstract class Route implements IRoute
return null;
}
public function setMethod(string $method): IRoute
public function setMethod($method)
{
$this->callback = sprintf('%s@%s', $this->getClass(), $method);
return $this;
}
public function setClass(string $class): IRoute
public function setClass($class)
{
$this->callback = sprintf('%s@%s', $class, $this->getMethod());
@@ -324,9 +325,9 @@ abstract class Route implements IRoute
/**
* @param string $namespace
* @return static
* @return static $this
*/
public function setNamespace(string $namespace): IRoute
public function setNamespace($namespace)
{
$this->namespace = $namespace;
@@ -335,26 +336,26 @@ abstract class Route implements IRoute
/**
* @param string $namespace
* @return static
* @return static $this
*/
public function setDefaultNamespace($namespace): IRoute
public function setDefaultNamespace($namespace)
{
$this->defaultNamespace = $namespace;
return $this;
}
public function getDefaultNamespace(): ?string
public function getDefaultNamespace()
{
return $this->defaultNamespace;
}
/**
* @return string|null
* @return string
*/
public function getNamespace(): ?string
public function getNamespace()
{
return $this->namespace ?? $this->defaultNamespace;
return ($this->namespace === null) ? $this->defaultNamespace : $this->namespace;
}
/**
@@ -362,7 +363,7 @@ abstract class Route implements IRoute
*
* @return array
*/
public function toArray(): array
public function toArray()
{
$values = [];
@@ -370,15 +371,15 @@ abstract class Route implements IRoute
$values['namespace'] = $this->namespace;
}
if (\count($this->requestMethods) !== 0) {
if (count($this->requestMethods) !== 0) {
$values['method'] = $this->requestMethods;
}
if (\count($this->where) !== 0) {
if (count($this->where) !== 0) {
$values['where'] = $this->where;
}
if (\count($this->middlewares) !== 0) {
if (count($this->middlewares) !== 0) {
$values['middleware'] = $this->middlewares;
}
@@ -394,9 +395,9 @@ abstract class Route implements IRoute
*
* @param array $values
* @param bool $merge
* @return static
* @return static $this
*/
public function setSettings(array $values, bool $merge = false): IRoute
public function setSettings(array $values, $merge = false)
{
if ($this->namespace === null && isset($values['namespace']) === true) {
$this->setNamespace($values['namespace']);
@@ -431,7 +432,7 @@ abstract class Route implements IRoute
*
* @return array
*/
public function getWhere(): array
public function getWhere()
{
return $this->where;
}
@@ -442,7 +443,7 @@ abstract class Route implements IRoute
* @param array $options
* @return static
*/
public function setWhere(array $options): IRoute
public function setWhere(array $options)
{
$this->where = $options;
@@ -467,12 +468,12 @@ abstract class Route implements IRoute
*
* @return array
*/
public function getParameters(): array
public function getParameters()
{
/* Sort the parameters after the user-defined param order, if any */
$parameters = [];
if (\count($this->originalParameters) !== 0) {
if (count($this->originalParameters) !== 0) {
$parameters = $this->originalParameters;
}
@@ -483,15 +484,15 @@ abstract class Route implements IRoute
* Get parameters
*
* @param array $parameters
* @return static
* @return static $this
*/
public function setParameters(array $parameters): IRoute
public function setParameters(array $parameters)
{
/*
* If this is the first time setting parameters we store them so we
* later can organize the array, in case somebody tried to sort the array.
*/
if (\count($parameters) !== 0 && \count($this->originalParameters) === 0) {
if (count($parameters) !== 0 && count($this->originalParameters) === 0) {
$this->originalParameters = $parameters;
}
@@ -520,7 +521,7 @@ abstract class Route implements IRoute
* @param IMiddleware|string $middleware
* @return static
*/
public function addMiddleware($middleware): IRoute
public function addMiddleware($middleware)
{
$this->middlewares[] = $middleware;
@@ -531,9 +532,9 @@ abstract class Route implements IRoute
* Set middlewares array
*
* @param array $middlewares
* @return static
* @return $this
*/
public function setMiddlewares(array $middlewares): IRoute
public function setMiddlewares(array $middlewares)
{
$this->middlewares = $middlewares;
@@ -543,7 +544,7 @@ abstract class Route implements IRoute
/**
* @return array
*/
public function getMiddlewares(): array
public function getMiddlewares()
{
return $this->middlewares;
}
@@ -553,7 +554,7 @@ abstract class Route implements IRoute
* This is used when no custom parameter regex is found.
*
* @param string $regex
* @return static
* @return static $this
*/
public function setDefaultParameterRegex($regex)
{
@@ -567,7 +568,7 @@ abstract class Route implements IRoute
*
* @return string
*/
public function getDefaultParameterRegex(): string
public function getDefaultParameterRegex()
{
return $this->defaultParameterRegex;
}
@@ -24,7 +24,7 @@ class RouteController extends LoadableRoute implements IControllerRoute
* @param string $name
* @return bool
*/
public function hasName(string $name): bool
public function hasName($name)
{
if ($this->name === null) {
return false;
@@ -35,7 +35,7 @@ class RouteController extends LoadableRoute implements IControllerRoute
$method = substr($name, strrpos($name, '.') + 1);
$newName = substr($name, 0, strrpos($name, '.'));
if (\in_array($method, $this->names, true) === true && strtolower($this->name) === strtolower($newName)) {
if (in_array($method, $this->names, false) === true && strtolower($this->name) === strtolower($newName)) {
return true;
}
}
@@ -49,7 +49,7 @@ class RouteController extends LoadableRoute implements IControllerRoute
* @param string|null $name
* @return string
*/
public function findUrl(?string $method = null, $parameters = null, ?string $name = null): string
public function findUrl($method = null, $parameters = null, $name = null)
{
if (strpos($name, '.') !== false) {
$found = array_search(substr($name, strrpos($name, '.') + 1), $this->names, false);
@@ -67,7 +67,7 @@ class RouteController extends LoadableRoute implements IControllerRoute
foreach (static::$requestTypes as $requestType) {
if (stripos($method, $requestType) === 0) {
$method = (string)substr($method, \strlen($requestType));
$method = (string)substr($method, strlen($requestType));
break;
}
}
@@ -77,7 +77,7 @@ class RouteController extends LoadableRoute implements IControllerRoute
$group = $this->getGroup();
if ($group !== null && \count($group->getDomains()) !== 0) {
if ($group !== null && count($group->getDomains()) !== 0) {
$url .= '//' . $group->getDomains()[0];
}
@@ -86,12 +86,8 @@ class RouteController extends LoadableRoute implements IControllerRoute
return '/' . trim($url, '/') . '/';
}
public function matchRoute($url, Request $request): bool
public function matchRoute($url, Request $request)
{
if ($this->getGroup() !== null && $this->getGroup()->matchRoute($url, $request) === false) {
return false;
}
/* Match global regular-expression for route */
$regexMatch = $this->matchRegex($request, $url);
@@ -102,12 +98,12 @@ class RouteController extends LoadableRoute implements IControllerRoute
$strippedUrl = trim(str_ireplace($this->url, '/', $url), '/');
$path = explode('/', $strippedUrl);
if (\count($path) !== 0) {
if (count($path) !== 0) {
$method = (isset($path[0]) === false || trim($path[0]) === '') ? $this->defaultMethod : $path[0];
$this->method = $request->getMethod() . ucfirst($method);
$this->parameters = \array_slice($path, 1);
$this->parameters = array_slice($path, 1);
// Set callback
$this->setCallback($this->controller . '@' . $this->method);
@@ -123,7 +119,7 @@ class RouteController extends LoadableRoute implements IControllerRoute
*
* @return string
*/
public function getController(): string
public function getController()
{
return $this->controller;
}
@@ -134,7 +130,7 @@ class RouteController extends LoadableRoute implements IControllerRoute
* @param string $controller
* @return static
*/
public function setController(string $controller): IControllerRoute
public function setController($controller)
{
$this->controller = $controller;
@@ -144,9 +140,9 @@ class RouteController extends LoadableRoute implements IControllerRoute
/**
* Return active method
*
* @return string|null
* @return string
*/
public function getMethod(): ?string
public function getMethod()
{
return $this->method;
}
@@ -157,7 +153,7 @@ class RouteController extends LoadableRoute implements IControllerRoute
* @param string $method
* @return static
*/
public function setMethod(string $method): IRoute
public function setMethod($method)
{
$this->method = $method;
@@ -171,7 +167,7 @@ class RouteController extends LoadableRoute implements IControllerRoute
* @param bool $merge
* @return static
*/
public function setSettings(array $values, bool $merge = false): IRoute
public function setSettings(array $values, $merge = false)
{
if (isset($values['names']) === true) {
$this->names = $values['names'];
+19 -23
View File
@@ -2,8 +2,8 @@
namespace Pecee\SimpleRouter\Route;
use Pecee\Handlers\IExceptionHandler;
use Pecee\Http\Request;
use Pecee\SimpleRouter\Handlers\IExceptionHandler;
class RouteGroup extends Route implements IGroupRoute
{
@@ -18,9 +18,9 @@ class RouteGroup extends Route implements IGroupRoute
* @param Request $request
* @return bool
*/
public function matchDomain(Request $request): bool
public function matchDomain(Request $request)
{
if ($this->domains === null || \count($this->domains) === 0) {
if ($this->domains === null || count($this->domains) === 0) {
return true;
}
@@ -28,7 +28,7 @@ class RouteGroup extends Route implements IGroupRoute
$parameters = $this->parseParameters($domain, $request->getHost(), '.*');
if ($parameters !== null && \count($parameters) !== 0) {
if ($parameters !== null && count($parameters) !== 0) {
$this->parameters = $parameters;
@@ -46,12 +46,8 @@ class RouteGroup extends Route implements IGroupRoute
* @param Request $request
* @return bool
*/
public function matchRoute($url, Request $request): bool
public function matchRoute($url, Request $request)
{
if ($this->getGroup() !== null && $this->getGroup()->matchRoute($url, $request) === false) {
return false;
}
/* Skip if prefix doesn't match */
if ($this->prefix !== null && stripos($url, $this->prefix) === false) {
return false;
@@ -64,9 +60,9 @@ class RouteGroup extends Route implements IGroupRoute
* Add exception handler
*
* @param IExceptionHandler|string $handler
* @return static
* @return static $this
*/
public function addExceptionHandler($handler): IGroupRoute
public function addExceptionHandler($handler)
{
$this->exceptionHandlers[] = $handler;
@@ -77,9 +73,9 @@ class RouteGroup extends Route implements IGroupRoute
* Set exception-handlers for group
*
* @param array $handlers
* @return static
* @return static $this
*/
public function setExceptionHandlers(array $handlers): IGroupRoute
public function setExceptionHandlers(array $handlers)
{
$this->exceptionHandlers = $handlers;
@@ -91,7 +87,7 @@ class RouteGroup extends Route implements IGroupRoute
*
* @return array
*/
public function getExceptionHandlers(): array
public function getExceptionHandlers()
{
return $this->exceptionHandlers;
}
@@ -101,7 +97,7 @@ class RouteGroup extends Route implements IGroupRoute
*
* @return array
*/
public function getDomains(): array
public function getDomains()
{
return $this->domains;
}
@@ -110,9 +106,9 @@ class RouteGroup extends Route implements IGroupRoute
* Set allowed domains for group.
*
* @param array $domains
* @return static
* @return $this
*/
public function setDomains(array $domains): IGroupRoute
public function setDomains(array $domains)
{
$this->domains = $domains;
@@ -123,7 +119,7 @@ class RouteGroup extends Route implements IGroupRoute
* @param string $prefix
* @return static
*/
public function setPrefix($prefix): IGroupRoute
public function setPrefix($prefix)
{
$this->prefix = '/' . trim($prefix, '/');
@@ -133,9 +129,9 @@ class RouteGroup extends Route implements IGroupRoute
/**
* Set prefix that child-routes will inherit.
*
* @return string|null
* @return string
*/
public function getPrefix(): ?string
public function getPrefix()
{
return $this->prefix;
}
@@ -147,7 +143,7 @@ class RouteGroup extends Route implements IGroupRoute
* @param bool $merge
* @return static
*/
public function setSettings(array $values, bool $merge = false): IRoute
public function setSettings(array $values, $merge = false)
{
if (isset($values['prefix']) === true) {
@@ -183,7 +179,7 @@ class RouteGroup extends Route implements IGroupRoute
*
* @return array
*/
public function toArray(): array
public function toArray()
{
$values = [];
@@ -195,7 +191,7 @@ class RouteGroup extends Route implements IGroupRoute
$values['as'] = $this->name;
}
if (\count($this->parameters) !== 0) {
if (count($this->parameters) !== 0) {
$values['parameters'] = $this->parameters;
}
@@ -6,14 +6,7 @@ use Pecee\Http\Request;
class RoutePartialGroup extends RouteGroup implements IPartialGroupRoute
{
/**
* RoutePartialGroup constructor.
*/
public function __construct()
{
$this->urlRegex = '/^%s\/?/u';
}
protected $urlRegex = '/^%s\/?/u';
/**
* Method called to check if route matches
@@ -22,12 +15,8 @@ class RoutePartialGroup extends RouteGroup implements IPartialGroupRoute
* @param Request $request
* @return bool
*/
public function matchRoute($url, Request $request): bool
public function matchRoute($url, Request $request)
{
if ($this->getGroup() !== null && $this->getGroup()->matchRoute($url, $request) === false) {
return false;
}
if ($this->prefix !== null) {
/* Parse parameters from current route */
$parameters = $this->parseParameters($this->prefix, $url);
+10 -20
View File
@@ -42,7 +42,7 @@ class RouteResource extends LoadableRoute implements IControllerRoute
* @param string $name
* @return bool
*/
public function hasName(string $name): bool
public function hasName($name)
{
if ($this->name === null) {
return false;
@@ -60,13 +60,7 @@ class RouteResource extends LoadableRoute implements IControllerRoute
return (strtolower($this->name) === strtolower($name));
}
/**
* @param string|null $method
* @param array|string|null $parameters
* @param string|null $name
* @return string
*/
public function findUrl(?string $method = null, $parameters = null, ?string $name = null): string
public function findUrl($method = null, $parameters = null, $name = null)
{
$url = array_search($name, $this->names, false);
if ($url !== false) {
@@ -83,12 +77,8 @@ class RouteResource extends LoadableRoute implements IControllerRoute
return true;
}
public function matchRoute($url, Request $request): bool
public function matchRoute($url, Request $request)
{
if ($this->getGroup() !== null && $this->getGroup()->matchRoute($url, $request) === false) {
return false;
}
/* Match global regular-expression for route */
$regexMatch = $this->matchRegex($request, $url);
@@ -120,7 +110,7 @@ class RouteResource extends LoadableRoute implements IControllerRoute
}
// Update
if ($id !== null && \in_array($method, [static::REQUEST_TYPE_PATCH, static::REQUEST_TYPE_PUT], true) === true) {
if ($id !== null && in_array($method, [static::REQUEST_TYPE_PATCH, static::REQUEST_TYPE_PUT], false) === true) {
return $this->call($this->methodNames['update']);
}
@@ -151,7 +141,7 @@ class RouteResource extends LoadableRoute implements IControllerRoute
/**
* @return string
*/
public function getController(): string
public function getController()
{
return $this->controller;
}
@@ -160,14 +150,14 @@ class RouteResource extends LoadableRoute implements IControllerRoute
* @param string $controller
* @return static
*/
public function setController(string $controller): IControllerRoute
public function setController($controller)
{
$this->controller = $controller;
return $this;
}
public function setName(string $name): ILoadableRoute
public function setName($name)
{
$this->name = $name;
@@ -200,9 +190,9 @@ class RouteResource extends LoadableRoute implements IControllerRoute
/**
* Get method names
*
* @return array
* @return array $this
*/
public function getMethodNames(): array
public function getMethodNames()
{
return $this->methodNames;
}
@@ -214,7 +204,7 @@ class RouteResource extends LoadableRoute implements IControllerRoute
* @param bool $merge
* @return static
*/
public function setSettings(array $values, bool $merge = false): IRoute
public function setSettings(array $values, $merge = false)
{
if (isset($values['names']) === true) {
$this->names = $values['names'];
+1 -5
View File
@@ -12,12 +12,8 @@ class RouteUrl extends LoadableRoute
$this->setCallback($callback);
}
public function matchRoute($url, Request $request): bool
public function matchRoute($url, Request $request)
{
if ($this->getGroup() !== null && $this->getGroup()->matchRoute($url, $request) === false) {
return false;
}
/* Match global regular-expression for route */
$regexMatch = $this->matchRegex($request, $url);
File diff suppressed because it is too large Load Diff
+44 -146
View File
@@ -10,23 +10,15 @@
namespace Pecee\SimpleRouter;
use DI\Container;
use Pecee\Exceptions\InvalidArgumentException;
use Pecee\Http\Exceptions\MalformedUrlException;
use Pecee\Handlers\CallbackExceptionHandler;
use Pecee\Http\Middleware\BaseCsrfVerifier;
use Pecee\Http\Request;
use Pecee\Http\Response;
use Pecee\Http\Url;
use Pecee\SimpleRouter\ClassLoader\IClassLoader;
use Pecee\SimpleRouter\Exceptions\HttpException;
use Pecee\SimpleRouter\Handlers\CallbackExceptionHandler;
use Pecee\SimpleRouter\Handlers\IEventHandler;
use Pecee\SimpleRouter\Route\IGroupRoute;
use Pecee\SimpleRouter\Route\IPartialGroupRoute;
use Pecee\SimpleRouter\Exceptions\NotFoundHttpException;
use Pecee\SimpleRouter\Route\IRoute;
use Pecee\SimpleRouter\Route\RoutePartialGroup;
use Pecee\SimpleRouter\Route\RouteController;
use Pecee\SimpleRouter\Route\RouteGroup;
use Pecee\SimpleRouter\Route\RoutePartialGroup;
use Pecee\SimpleRouter\Route\RouteResource;
use Pecee\SimpleRouter\Route\RouteUrl;
@@ -34,7 +26,7 @@ class SimpleRouter
{
/**
* Default namespace added to all routes
* @var string|null
* @var string
*/
protected static $defaultNamespace;
@@ -51,72 +43,13 @@ class SimpleRouter
protected static $router;
/**
* Start routing
* Start/route request
*
* @throws \Pecee\SimpleRouter\Exceptions\NotFoundHttpException
* @throws \Pecee\Http\Middleware\Exceptions\TokenMismatchException
* @throws HttpException
* @throws \Exception
* @throws HttpException|NotFoundHttpException|\Exception
*/
public static function start(): void
public static function start()
{
echo static::router()->start();
}
/**
* Start the routing an return array with debugging-information
*
* @return array
*/
public static function startDebug(): array
{
$routerOutput = null;
try {
ob_start();
static::router()->setDebugEnabled(true);
static::start();
$routerOutput = ob_get_contents();
ob_end_clean();
} catch (\Exception $e) {
}
// Try to parse library version
$composerFile = \dirname(__DIR__, 3) . '/composer.lock';
$version = false;
if (is_file($composerFile) === true) {
$composerInfo = json_decode(file_get_contents($composerFile), true);
if (isset($composerInfo['packages']) === true && \is_array($composerInfo['packages']) === true) {
foreach ($composerInfo['packages'] as $package) {
if (isset($package['name']) === true && strtolower($package['name']) === 'pecee/simple-router') {
$version = $package['version'];
break;
}
}
}
}
$request = static::request();
$router = static::router();
return [
'url' => $request->getUrl(),
'method' => $request->getMethod(),
'host' => $request->getHost(),
'loaded_routes' => $request->getLoadedRoutes(),
'all_routes' => $router->getRoutes(),
'boot_managers' => $router->getBootManagers(),
'csrf_verifier' => $router->getCsrfVerifier(),
'log' => $router->getDebugLog(),
'event_handlers' => $router->getEventHandlers(),
'router_output' => $routerOutput,
'library_version' => $version,
'php_version' => PHP_VERSION,
'server_params' => $request->getHeaders(),
];
echo static::router()->routeRequest();
}
/**
@@ -124,7 +57,7 @@ class SimpleRouter
*
* @param string $defaultNamespace
*/
public static function setDefaultNamespace(string $defaultNamespace): void
public static function setDefaultNamespace($defaultNamespace)
{
static::$defaultNamespace = $defaultNamespace;
}
@@ -134,28 +67,18 @@ class SimpleRouter
*
* @param BaseCsrfVerifier $baseCsrfVerifier
*/
public static function csrfVerifier(BaseCsrfVerifier $baseCsrfVerifier): void
public static function csrfVerifier(BaseCsrfVerifier $baseCsrfVerifier)
{
static::router()->setCsrfVerifier($baseCsrfVerifier);
}
/**
* Add new event handler to the router
*
* @param IEventHandler $eventHandler
*/
public static function addEventHandler(IEventHandler $eventHandler): void
{
static::router()->addEventHandler($eventHandler);
}
/**
* Boot managers allows you to alter the routes before the routing occurs.
* Perfect if you want to load pretty-urls from a file or database.
*
* @param IRouterBootManager $bootManager
*/
public static function addBootManager(IRouterBootManager $bootManager): void
public static function addBootManager(IRouterBootManager $bootManager)
{
static::router()->addBootManager($bootManager);
}
@@ -166,10 +89,9 @@ class SimpleRouter
* @param string $url
* @param string|\Closure $callback
* @param array|null $settings
*
* @return RouteUrl
*/
public static function get(string $url, $callback, array $settings = null): IRoute
public static function get($url, $callback, array $settings = null)
{
return static::match(['get'], $url, $callback, $settings);
}
@@ -182,7 +104,7 @@ class SimpleRouter
* @param array|null $settings
* @return RouteUrl
*/
public static function post(string $url, $callback, array $settings = null): IRoute
public static function post($url, $callback, array $settings = null)
{
return static::match(['post'], $url, $callback, $settings);
}
@@ -195,7 +117,7 @@ class SimpleRouter
* @param array|null $settings
* @return RouteUrl
*/
public static function put(string $url, $callback, array $settings = null): IRoute
public static function put($url, $callback, array $settings = null)
{
return static::match(['put'], $url, $callback, $settings);
}
@@ -208,7 +130,7 @@ class SimpleRouter
* @param array|null $settings
* @return RouteUrl
*/
public static function patch(string $url, $callback, array $settings = null): IRoute
public static function patch($url, $callback, array $settings = null)
{
return static::match(['patch'], $url, $callback, $settings);
}
@@ -221,7 +143,7 @@ class SimpleRouter
* @param array|null $settings
* @return RouteUrl
*/
public static function options(string $url, $callback, array $settings = null): IRoute
public static function options($url, $callback, array $settings = null)
{
return static::match(['options'], $url, $callback, $settings);
}
@@ -234,7 +156,7 @@ class SimpleRouter
* @param array|null $settings
* @return RouteUrl
*/
public static function delete(string $url, $callback, array $settings = null): IRoute
public static function delete($url, $callback, array $settings = null)
{
return static::match(['delete'], $url, $callback, $settings);
}
@@ -244,13 +166,13 @@ class SimpleRouter
*
* @param array $settings
* @param \Closure $callback
* @throws \InvalidArgumentException
* @return RouteGroup
* @throws InvalidArgumentException
*/
public static function group(array $settings = [], \Closure $callback): IGroupRoute
public static function group(array $settings = [], \Closure $callback)
{
if (\is_callable($callback) === false) {
throw new InvalidArgumentException('Invalid callback provided. Only functions or methods supported');
if (is_callable($callback) === false) {
throw new \InvalidArgumentException('Invalid callback provided. Only functions or methods supported');
}
$group = new RouteGroup();
@@ -267,15 +189,15 @@ class SimpleRouter
* parameters and which are only rendered when the url matches.
*
* @param string $url
* @param \Closure $callback
* @param array $settings
* @param \Closure $callback
* @throws \InvalidArgumentException
* @return RoutePartialGroup
* @throws InvalidArgumentException
*/
public static function partialGroup(string $url, \Closure $callback, array $settings = []): IPartialGroupRoute
public static function partialGroup($url, \Closure $callback, array $settings = [])
{
if (\is_callable($callback) === false) {
throw new InvalidArgumentException('Invalid callback provided. Only functions or methods supported');
if (is_callable($callback) === false) {
throw new \InvalidArgumentException('Invalid callback provided. Only functions or methods supported');
}
$settings['prefix'] = $url;
@@ -298,7 +220,7 @@ class SimpleRouter
* @see SimpleRouter::form
* @return RouteUrl
*/
public static function basic(string $url, $callback, array $settings = null): IRoute
public static function basic($url, $callback, array $settings = null)
{
return static::match(['get', 'post'], $url, $callback, $settings);
}
@@ -313,7 +235,7 @@ class SimpleRouter
* @see SimpleRouter::form
* @return RouteUrl
*/
public static function form(string $url, $callback, array $settings = null): IRoute
public static function form($url, $callback, array $settings = null)
{
return static::match(['get', 'post'], $url, $callback, $settings);
}
@@ -327,7 +249,7 @@ class SimpleRouter
* @param array|null $settings
* @return RouteUrl|IRoute
*/
public static function match(array $requestMethods, string $url, $callback, array $settings = null)
public static function match(array $requestMethods, $url, $callback, array $settings = null)
{
$route = new RouteUrl($url, $callback);
$route->setRequestMethods($requestMethods);
@@ -350,7 +272,7 @@ class SimpleRouter
* @param array|null $settings
* @return RouteUrl|IRoute
*/
public static function all(string $url, $callback, array $settings = null)
public static function all($url, $callback, array $settings = null)
{
$route = new RouteUrl($url, $callback);
$route = static::addDefaultNamespace($route);
@@ -372,7 +294,7 @@ class SimpleRouter
* @param array|null $settings
* @return RouteController|IRoute
*/
public static function controller(string $url, $controller, array $settings = null)
public static function controller($url, $controller, array $settings = null)
{
$route = new RouteController($url, $controller);
$route = static::addDefaultNamespace($route);
@@ -394,7 +316,7 @@ class SimpleRouter
* @param array|null $settings
* @return RouteResource|IRoute
*/
public static function resource(string $url, $controller, array $settings = null)
public static function resource($url, $controller, array $settings = null)
{
$route = new RouteResource($url, $controller);
$route = static::addDefaultNamespace($route);
@@ -414,7 +336,7 @@ class SimpleRouter
* @param \Closure $callback
* @return CallbackExceptionHandler $callbackHandler
*/
public static function error(\Closure $callback): CallbackExceptionHandler
public static function error(\Closure $callback)
{
$routes = static::router()->getRoutes();
@@ -445,22 +367,12 @@ class SimpleRouter
* @param string|null $name
* @param string|array|null $parameters
* @param array|null $getParams
* @return Url
* @throws \InvalidArgumentException
* @return string
*/
public static function getUrl(?string $name = null, $parameters = null, $getParams = null): Url
public static function getUrl($name = null, $parameters = null, $getParams = null)
{
try {
return static::router()->getUrl($name, $parameters, $getParams);
} catch (\Exception $e) {
try {
return new Url('/');
} catch (MalformedUrlException $e) {
}
}
// This will never happen...
return null;
return static::router()->getUrl($name, $parameters, $getParams);
}
/**
@@ -468,7 +380,7 @@ class SimpleRouter
*
* @return \Pecee\Http\Request
*/
public static function request(): Request
public static function request()
{
return static::router()->getRequest();
}
@@ -478,7 +390,7 @@ class SimpleRouter
*
* @return Response
*/
public static function response(): Response
public static function response()
{
if (static::$response === null) {
static::$response = new Response(static::request());
@@ -492,7 +404,7 @@ class SimpleRouter
*
* @return Router
*/
public static function router(): Router
public static function router()
{
if (static::$router === null) {
static::$router = new Router();
@@ -507,14 +419,14 @@ class SimpleRouter
* @param IRoute $route
* @return IRoute
*/
public static function addDefaultNamespace(IRoute $route): IRoute
public static function addDefaultNamespace(IRoute $route)
{
if (static::$defaultNamespace !== null) {
$callback = $route->getCallback();
/* Only add default namespace on relative callbacks */
if ($callback === null || (\is_string($callback) === true && $callback[0] !== '\\')) {
if ($callback === null || (is_string($callback) === true && $callback[0] !== '\\')) {
$namespace = static::$defaultNamespace;
@@ -532,25 +444,11 @@ class SimpleRouter
return $route;
}
/**
* Enable or disable dependency injection
*
* @param Container $container
* @return IClassLoader
*/
public static function enableDependencyInjection(Container $container): IClassLoader
{
return static::router()
->getClassLoader()
->useDependencyInjection(true)
->setContainer($container);
}
/**
* Get default namespace
* @return string|null
* @return string
*/
public static function getDefaultNamespace(): ?string
public static function getDefaultNamespace()
{
return static::$defaultNamespace;
}
@@ -1,11 +1,11 @@
<?php
require_once 'Exception/MiddlewareLoadedException.php';
require_once 'Exceptions/MiddlewareLoadedException.php';
use Pecee\Http\Request;
class DummyMiddleware implements \Pecee\Http\Middleware\IMiddleware
{
public function handle(Request $request) : void
public function handle(Request $request)
{
throw new MiddlewareLoadedException('Middleware loaded!');
}
@@ -1,5 +1,4 @@
<?php
class ExceptionHandlerException extends \Exception
{
}
@@ -1,8 +1,8 @@
<?php
class ExceptionHandler implements \Pecee\SimpleRouter\Handlers\IExceptionHandler
class ExceptionHandler implements \Pecee\Handlers\IExceptionHandler
{
public function handleError(\Pecee\Http\Request $request, \Exception $error) : void
public function handleError(\Pecee\Http\Request $request, \Exception $error)
{
echo $error->getMessage();
}
@@ -0,0 +1,14 @@
<?php
class ExceptionHandlerFirst implements \Pecee\Handlers\IExceptionHandler
{
public function handleError(\Pecee\Http\Request $request, \Exception $error)
{
global $stack;
$stack[] = static::class;
$request->setUri(new \Pecee\Http\Uri('/'));
return $request;
}
}
@@ -0,0 +1,14 @@
<?php
class ExceptionHandlerSecond implements \Pecee\Handlers\IExceptionHandler
{
public function handleError(\Pecee\Http\Request $request, \Exception $error)
{
global $stack;
$stack[] = static::class;
$request->setUri(new \Pecee\Http\Uri('/'));
return $request;
}
}
@@ -1,8 +1,8 @@
<?php
class ExceptionHandlerThird implements \Pecee\SimpleRouter\Handlers\IExceptionHandler
class ExceptionHandlerThird implements \Pecee\Handlers\IExceptionHandler
{
public function handleError(\Pecee\Http\Request $request, \Exception $error) : void
public function handleError(\Pecee\Http\Request $request, \Exception $error)
{
global $stack;
$stack[] = static::class;
@@ -5,7 +5,7 @@ use Pecee\Http\Request;
class RewriteMiddleware implements IMiddleware {
public function handle(Request $request) : void {
public function handle(Request $request) {
$request->setRewriteCallback(function() {
return 'ok';
+39
View File
@@ -0,0 +1,39 @@
<?php
class ResourceController implements \Pecee\Controllers\IResourceController
{
public function index()
{
echo 'index';
}
public function show($id)
{
echo 'show ' . $id;
}
public function store()
{
echo 'store';
}
public function create()
{
echo 'create';
}
public function edit($id)
{
echo 'edit ' . $id;
}
public function update($id)
{
echo 'update ' . $id;
}
public function destroy($id)
{
echo 'destroy ' . $id;
}
}
@@ -2,16 +2,18 @@
require_once 'Dummy/DummyMiddleware.php';
require_once 'Dummy/DummyController.php';
require_once 'Helpers/TestRouter.php';
class GroupTest extends \PHPUnit\Framework\TestCase
class GroupTest extends PHPUnit_Framework_TestCase
{
protected $result;
public function testGroupLoad()
{
$result = false;
$this->result = false;
TestRouter::group(['prefix' => '/group'], function () use(&$result) {
$result = true;
TestRouter::group(['prefix' => '/group'], function () {
$this->result = true;
});
try {
@@ -19,7 +21,7 @@ class GroupTest extends \PHPUnit\Framework\TestCase
} catch(\Exception $e) {
}
$this->assertTrue($result);
$this->assertTrue($this->result);
}
public function testNestedGroup()
@@ -35,7 +37,6 @@ class GroupTest extends \PHPUnit\Framework\TestCase
TestRouter::debug('/api/v1/test', 'get');
$this->assertTrue(true);
}
public function testMultipleRoutes()
@@ -60,8 +61,6 @@ class GroupTest extends \PHPUnit\Framework\TestCase
});
TestRouter::debug('/my/match', 'get');
$this->assertTrue(true);
}
public function testUrls()
@@ -3,20 +3,18 @@
class TestRouter extends \Pecee\SimpleRouter\SimpleRouter
{
public static function debugNoReset($testUrl, $testMethod = 'get')
public static function debugNoReset($testUri, $testMethod = 'get')
{
$request = static::request();
$request->setUrl((new \Pecee\Http\Url($testUrl))->setHost('local.unitTest'));
$request->setMethod($testMethod);
static::request()->setUri(new \Pecee\Http\Uri($testUri));
static::request()->setMethod($testMethod);
static::start();
}
public static function debug($testUrl, $testMethod = 'get')
public static function debug($testUri, $testMethod = 'get')
{
try {
static::debugNoReset($testUrl, $testMethod);
static::debugNoReset($testUri, $testMethod);
} catch(\Exception $e) {
static::router()->reset();
throw $e;
@@ -26,13 +24,13 @@ class TestRouter extends \Pecee\SimpleRouter\SimpleRouter
}
public static function debugOutput($testUrl, $testMethod = 'get')
public static function debugOutput($testUri, $testMethod = 'get')
{
$response = null;
// Route request
ob_start();
static::debug($testUrl, $testMethod);
static::debug($testUri, $testMethod);
$response = ob_get_contents();
ob_end_clean();
@@ -3,12 +3,13 @@
require_once 'Dummy/DummyMiddleware.php';
require_once 'Dummy/DummyController.php';
require_once 'Dummy/Handler/ExceptionHandler.php';
require_once 'Helpers/TestRouter.php';
class MiddlewareTest extends \PHPUnit\Framework\TestCase
class MiddlewareTest extends PHPUnit_Framework_TestCase
{
public function testMiddlewareFound()
{
$this->expectException(MiddlewareLoadedException::class);
$this->setExpectedException(MiddlewareLoadedException::class);
TestRouter::group(['exceptionHandler' => 'ExceptionHandler'], function () {
TestRouter::get('/my/test/url', 'DummyController@method1', ['middleware' => 'DummyMiddleware']);
@@ -28,8 +29,6 @@ class MiddlewareTest extends \PHPUnit\Framework\TestCase
TestRouter::get('/my/test/url', 'DummyController@method1');
TestRouter::debug('/my/test/url', 'get');
$this->assertTrue(true);
}
}
@@ -2,14 +2,15 @@
require_once 'Dummy/DummyMiddleware.php';
require_once 'Dummy/DummyController.php';
require_once 'Dummy/Exception/ExceptionHandlerException.php';
require_once 'Dummy/Exceptions/ExceptionHandlerException.php';
require_once 'Helpers/TestRouter.php';
class RouterCallbackExceptionHandlerTest extends \PHPUnit\Framework\TestCase
class RouterCallbackExceptionHandlerTest extends PHPUnit_Framework_TestCase
{
public function testCallbackExceptionHandler()
{
$this->expectException(ExceptionHandlerException::class);
$this->setExpectedException(ExceptionHandlerException::class);
// Match normal route on alias
TestRouter::get('/my-new-url', 'DummyController@method2');
@@ -21,8 +22,6 @@ class RouterCallbackExceptionHandlerTest extends \PHPUnit\Framework\TestCase
TestRouter::debugNoReset('/404-url', 'get');
TestRouter::router()->reset();
$this->assertTrue(true);
}
}
@@ -1,8 +1,9 @@
<?php
require_once 'Dummy/DummyController.php';
require_once 'Helpers/TestRouter.php';
class RouterControllerTest extends \PHPUnit\Framework\TestCase
class RouterControllerTest extends PHPUnit_Framework_TestCase
{
public function testGet()
@@ -3,8 +3,9 @@
require_once 'Dummy/DummyMiddleware.php';
require_once 'Dummy/DummyController.php';
require_once 'Dummy/Handler/ExceptionHandler.php';
require_once 'Helpers/TestRouter.php';
class RouterPartialGroupTest extends \PHPUnit\Framework\TestCase
class RouterPartialGroupTest extends PHPUnit_Framework_TestCase
{
public function testParameters()
@@ -1,8 +1,9 @@
<?php
require_once 'Dummy/ResourceController.php';
require_once 'Helpers/TestRouter.php';
class RouterResourceTest extends \PHPUnit\Framework\TestCase
class RouterResourceTest extends PHPUnit_Framework_TestCase
{
public function testResourceStore()
@@ -1,12 +1,13 @@
<?php
require_once 'Dummy/DummyController.php';
require_once 'Dummy/Exception/ResponseException.php';
require_once 'Dummy/Exceptions/ResponseException.php';
require_once 'Dummy/Handler/ExceptionHandlerFirst.php';
require_once 'Dummy/Handler/ExceptionHandlerSecond.php';
require_once 'Dummy/Handler/ExceptionHandlerThird.php';
require_once 'Dummy/Middleware/RewriteMiddleware.php';
require_once 'Helpers/TestRouter.php';
require_once 'Dummy/Middlewares/RewriteMiddleware.php';
class RouteRewriteTest extends \PHPUnit\Framework\TestCase
class RouteRewriteTest extends PHPUnit_Framework_TestCase
{
/**
@@ -60,11 +61,11 @@ class RouteRewriteTest extends \PHPUnit\Framework\TestCase
public function testRewriteExceptionMessage()
{
$this->expectException(\Pecee\SimpleRouter\Exceptions\NotFoundHttpException::class);
$this->setExpectedException(\Pecee\SimpleRouter\Exceptions\NotFoundHttpException::class);
TestRouter::error(function (\Pecee\Http\Request $request, \Exception $error) {
if (strtolower($request->getUrl()->getPath()) === '/my/test/') {
if (strtolower($request->getUri()->getPath()) === '/my/test/') {
$request->setRewriteUrl('/another-non-existing');
}
@@ -2,30 +2,32 @@
require_once 'Dummy/DummyMiddleware.php';
require_once 'Dummy/DummyController.php';
require_once 'Dummy/Exception/ExceptionHandlerException.php';
require_once 'Dummy/Exceptions/ExceptionHandlerException.php';
require_once 'Helpers/TestRouter.php';
class RouterRouteTest extends \PHPUnit\Framework\TestCase
class RouterRouteTest extends PHPUnit_Framework_TestCase
{
protected $result = false;
public function testMultiParam()
{
$result = false;
TestRouter::get('/test-{param1}-{param2}', function ($param1, $param2) use(&$result) {
TestRouter::get('/test-{param1}-{param2}', function ($param1, $param2) {
if ($param1 === 'param1' && $param2 === 'param2') {
$result = true;
$this->result = true;
}
});
TestRouter::debug('/test-param1-param2', 'get');
$this->assertTrue($result);
$this->assertTrue($this->result);
}
public function testNotFound()
{
$this->expectException('\Pecee\SimpleRouter\Exceptions\NotFoundHttpException');
$this->setExpectedException('\Pecee\SimpleRouter\Exceptions\NotFoundHttpException');
TestRouter::get('/non-existing-path', 'DummyController@method1');
TestRouter::debug('/test-param1-param2', 'post');
}
@@ -34,32 +36,24 @@ class RouterRouteTest extends \PHPUnit\Framework\TestCase
{
TestRouter::get('/my/test/url', 'DummyController@method1');
TestRouter::debug('/my/test/url', 'get');
$this->assertTrue(true);
}
public function testPost()
{
TestRouter::post('/my/test/url', 'DummyController@method1');
TestRouter::debug('/my/test/url', 'post');
$this->assertTrue(true);
}
public function testPut()
{
TestRouter::put('/my/test/url', 'DummyController@method1');
TestRouter::debug('/my/test/url', 'put');
$this->assertTrue(true);
}
public function testDelete()
{
TestRouter::delete('/my/test/url', 'DummyController@method1');
TestRouter::debug('/my/test/url', 'delete');
$this->assertTrue(true);
}
public function testMethodNotAllowed()
@@ -91,37 +85,37 @@ class RouterRouteTest extends \PHPUnit\Framework\TestCase
public function testDomainAllowedRoute()
{
$result = false;
TestRouter::request()->setHost('hello.world.com');
$this->result = false;
TestRouter::group(['domain' => '{subdomain}.world.com'], function () use(&$result) {
TestRouter::get('/test', function ($subdomain = null) use(&$result) {
$result = ($subdomain === 'hello');
TestRouter::group(['domain' => '{subdomain}.world.com'], function () {
TestRouter::get('/test', function ($subdomain = null) {
$this->result = ($subdomain === 'hello');
});
});
TestRouter::request()->setHost('hello.world.com');
TestRouter::debug('/test', 'get');
$this->assertTrue($result);
$this->assertTrue($this->result);
}
public function testDomainNotAllowedRoute()
{
TestRouter::request()->setHost('other.world.com');
$this->result = false;
$result = false;
TestRouter::group(['domain' => '{subdomain}.world.com'], function () use(&$result) {
TestRouter::get('/test', function ($subdomain = null) use(&$result) {
$result = ($subdomain === 'hello');
TestRouter::group(['domain' => '{subdomain}.world.com'], function () {
TestRouter::get('/test', function ($subdomain = null) {
$this->result = ($subdomain === 'hello');
});
});
TestRouter::request()->setHost('other.world.com');
TestRouter::debug('/test', 'get');
$this->assertFalse($result);
$this->assertFalse($this->result);
}
@@ -129,8 +123,6 @@ class RouterRouteTest extends \PHPUnit\Framework\TestCase
{
TestRouter::get('/my/{path}', 'DummyController@method1')->where(['path' => '[a-zA-Z\-]+']);
TestRouter::debug('/my/custom-path', 'get');
$this->assertTrue(true);
}
public function testParameterDefaultValue() {
@@ -3,8 +3,9 @@
require_once 'Dummy/DummyMiddleware.php';
require_once 'Dummy/DummyController.php';
require_once 'Dummy/Handler/ExceptionHandler.php';
require_once 'Helpers/TestRouter.php';
class RouterUrlTest extends \PHPUnit\Framework\TestCase
class RouterUrlTest extends PHPUnit_Framework_TestCase
{
public function testIssue253()
@@ -31,22 +32,21 @@ class RouterUrlTest extends \PHPUnit\Framework\TestCase
{
// Test spanish characters
TestRouter::get('/cursos/listado/{listado?}/{category?}', 'DummyController@method1', ['defaultParameterRegex' => '[\w\p{L}\s-]+']);
TestRouter::get('/test/{param}', 'DummyController@method1', ['defaultParameterRegex' => '[\w\p{L}\s-\í]+']);
TestRouter::debugNoReset('/cursos/listado/especialidad/cirugía local', 'get');
$this->assertEquals('/cursos/listado/{listado?}/{category?}/', TestRouter::router()->getRequest()->getLoadedRoute()->getUrl());
TestRouter::debugNoReset('/test/Dermatología');
$parameters = TestRouter::request()->getLoadedRoute()->getParameters();
$this->assertEquals('Dermatología', $parameters['param']);
// Test danish characters
TestRouter::get('/kategori/økse', 'DummyController@method1', ['defaultParameterRegex' => '[\w\ø]+']);
TestRouter::debugNoReset('/kategori/økse', 'get');
$this->assertEquals('/kategori/økse/', TestRouter::router()->getRequest()->getLoadedRoute()->getUrl());
TestRouter::get('/test/{param}', 'DummyController@method1', ['defaultParameterRegex' => '[\w\p{L}\s-\í]+']);
TestRouter::debugNoReset('/test/Dermatología');
$parameters = TestRouter::request()->getLoadedRoute()->getParameters();
$this->assertEquals('Dermatología', $parameters['param']);
TestRouter::router()->reset();
}
@@ -1,53 +0,0 @@
<?php
require_once 'Dummy/DummyMiddleware.php';
class DependencyInjectionTest extends \PHPUnit\Framework\TestCase
{
public function testDependencyInjectionDevelopment()
{
$builder = new \DI\ContainerBuilder();
$container = $builder
->useAutowiring(true)
->ignorePhpDocErrors(true)
->build();
TestRouter::enableDependencyInjection($container);
$className = null;
TestRouter::get('/', function (DummyMiddleware $url) use (&$className) {
$className = \get_class($url);
});
TestRouter::debug('/');
$this->assertEquals(DummyMiddleware::class, $className);
}
public function testDependencyInjectionProduction()
{
$cacheDir = dirname(__DIR__, 2) . '/tmp';
$builder = new \DI\ContainerBuilder();
$builder
->enableCompilation($cacheDir)
->writeProxiesToFile(true, $cacheDir . '/proxies')
->ignorePhpDocErrors(true)
->useAutowiring(true);
$container = $builder->build();
TestRouter::enableDependencyInjection($container);
$className = null;
TestRouter::get('/', function (DummyMiddleware $url) use (&$className) {
$className = \get_class($url);
});
TestRouter::debug('/');
$this->assertEquals(DummyMiddleware::class, $className);
}
}
@@ -1,13 +0,0 @@
<?php
class ExceptionHandlerFirst implements \Pecee\SimpleRouter\Handlers\IExceptionHandler
{
public function handleError(\Pecee\Http\Request $request, \Exception $error) : void
{
global $stack;
$stack[] = static::class;
$request->setUrl(new \Pecee\Http\Url('/'));
}
}
@@ -1,13 +0,0 @@
<?php
class ExceptionHandlerSecond implements \Pecee\SimpleRouter\Handlers\IExceptionHandler
{
public function handleError(\Pecee\Http\Request $request, \Exception $error) : void
{
global $stack;
$stack[] = static::class;
$request->setUrl(new \Pecee\Http\Url('/'));
}
}
@@ -1,32 +0,0 @@
<?php
class TestBootManager implements \Pecee\SimpleRouter\IRouterBootManager
{
protected $routes;
protected $aliasUrl;
public function __construct(array $routes, string $aliasUrl)
{
$this->routes = $routes;
$this->aliasUrl = $aliasUrl;
}
/**
* Called when router loads it's routes
*
* @param \Pecee\SimpleRouter\Router $router
* @param \Pecee\Http\Request $request
*/
public function boot(\Pecee\SimpleRouter\Router $router, \Pecee\Http\Request $request): void
{
foreach ($this->routes as $url) {
// If the current url matches the rewrite url, we use our custom route
if ($request->getUrl()->contains($url) === true) {
$request->setRewriteUrl($this->aliasUrl);
}
}
}
}
@@ -1,46 +0,0 @@
<?php
class ResourceController implements \Pecee\Controllers\IResourceController
{
public function index() : ?string
{
echo 'index';
return null;
}
public function show($id) : ?string
{
echo 'show ' . $id;
return null;
}
public function store() : ?string
{
echo 'store';
return null;
}
public function create() : ?string
{
echo 'create';
return null;
}
public function edit($id) : ?string
{
echo 'edit ' . $id;
return null;
}
public function update($id) : ?string
{
echo 'update ' . $id;
return null;
}
public function destroy($id) : ?string
{
echo 'destroy ' . $id;
return null;
}
}
@@ -1,41 +0,0 @@
<?php
class SilentTokenProvider implements \Pecee\Http\Security\ITokenProvider {
protected $token;
public function __construct()
{
$this->refresh();
}
/**
* Refresh existing token
*/
public function refresh(): void
{
$this->token = uniqid('', false);
}
/**
* Validate valid CSRF token
*
* @param string $token
* @return bool
*/
public function validate(string $token): bool
{
return ($token === $this->token);
}
/**
* Get token token
*
* @param string|null $defaultValue
* @return string|null
*/
public function getToken(?string $defaultValue = null): ?string
{
return $this->token ?? $defaultValue;
}
}
@@ -1,81 +0,0 @@
<?php
require_once 'Dummy/DummyMiddleware.php';
require_once 'Dummy/DummyController.php';
require_once 'Dummy/Handler/ExceptionHandler.php';
require_once 'Dummy/Security/SilentTokenProvider.php';
require_once 'Dummy/Managers/TestBootManager.php';
use \Pecee\SimpleRouter\Handlers\EventHandler;
use \Pecee\SimpleRouter\Event\EventArgument;
class EventHandlerTest extends \PHPUnit\Framework\TestCase
{
public function testAllEventTriggered()
{
$events = EventHandler::$events;
// Remove the all event
unset($events[\array_search(EventHandler::EVENT_ALL, $events, true)]);
$eventHandler = new EventHandler();
$eventHandler->register(EventHandler::EVENT_ALL, function (EventArgument $arg) use (&$events) {
$key = \array_search($arg->getEventName(), $events, true);
unset($events[$key]);
});
TestRouter::addEventHandler($eventHandler);
// Add rewrite
TestRouter::error(function (\Pecee\Http\Request $request, \Exception $error) {
// Trigger rewrite
$request->setRewriteUrl('/');
});
TestRouter::get('/', 'DummyController@method1')->name('home');
// Trigger findRoute
TestRouter::router()->findRoute('home');
// Trigger getUrl
TestRouter::router()->getUrl('home');
// Add csrf-verifier
$csrfVerifier = new \Pecee\Http\Middleware\BaseCsrfVerifier();
$csrfVerifier->setTokenProvider(new SilentTokenProvider());
TestRouter::csrfVerifier($csrfVerifier);
// Add boot-manager
TestRouter::addBootManager(new TestBootManager([
'/test',
], '/'));
// Start router
TestRouter::debug('/non-existing');
$this->assertEquals($events, []);
}
public function testAllEvent()
{
$status = false;
$eventHandler = new EventHandler();
$eventHandler->register(EventHandler::EVENT_ALL, function (EventArgument $arg) use (&$status) {
$status = true;
});
TestRouter::addEventHandler($eventHandler);
TestRouter::get('/', 'DummyController@method1');
TestRouter::debug('/');
// All event should fire for each other event
$this->assertEquals(true, $status);
}
}
@@ -1,35 +0,0 @@
<?php
require_once 'Dummy/DummyMiddleware.php';
require_once 'Dummy/DummyController.php';
require_once 'Dummy/Handler/ExceptionHandler.php';
class InputHandlerTest extends \PHPUnit\Framework\TestCase
{
public function testGet()
{
$this->assertEquals(true, true);
}
public function testPost()
{
$this->assertEquals(true, true);
}
public function testFile()
{
$this->assertEquals(true, true);
}
public function testFiles()
{
$this->assertEquals(true, true);
}
public function testAll()
{
$this->assertEquals(true, true);
}
}
-4
View File
@@ -1,4 +0,0 @@
<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
require_once 'TestRouter.php';
-9
View File
@@ -1,9 +0,0 @@
<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use \Pecee\SimpleRouter\SimpleRouter;
SimpleRouter::get('/user/{name}', 'UserController@show')->where(['name' => '[\w]+']);
$debugInfo = SimpleRouter::startDebug();
echo sprintf('<pre>%s</pre>', var_export($debugInfo, true));
exit;