mirror of
https://github.com/skipperbent/simple-php-router.git
synced 2026-07-11 13:32:16 +00:00
@@ -1,100 +0,0 @@
|
|||||||
# Simple PHP router demo project
|
|
||||||
|
|
||||||
This project is here to give you a basic understanding of how to setup and using simple-php-router.
|
|
||||||
|
|
||||||
Please note that this demo-project only covers how to integrate the `simple-php-router` in a project without a framework. If you are using some sort of PHP framework in your project the implementation might vary.
|
|
||||||
|
|
||||||
**What we won't cover:**
|
|
||||||
|
|
||||||
- How to setup a solution that fits your need. This is a basic demo to help you get started.
|
|
||||||
- Understanding of MVC; including Controllers, Middlewares or ExceptionHandlers.
|
|
||||||
- How to integrate into third party frameworks.
|
|
||||||
|
|
||||||
**What we cover:**
|
|
||||||
|
|
||||||
- How to get up and running fast - from scratch.
|
|
||||||
- How to get ExceptionHandlers, Middlewares and Controllers working.
|
|
||||||
- How to setup your webservers.
|
|
||||||
|
|
||||||
## Installation
|
|
||||||
|
|
||||||
- Navigate to the `demo-project` folder in terminal and run `composer update` to install the latest version.
|
|
||||||
- Point your webserver to `demo-project/public`.
|
|
||||||
|
|
||||||
### Setting up Nginx
|
|
||||||
|
|
||||||
If you are using Nginx please make sure that url-rewriting is enabled.
|
|
||||||
|
|
||||||
You can easily enable url-rewriting by adding the following configuration for the Nginx configuration-file for the demo-project.
|
|
||||||
|
|
||||||
```
|
|
||||||
location / {
|
|
||||||
try_files $uri $uri/ /index.php?$query_string;
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Setting up Apache
|
|
||||||
|
|
||||||
Nothing special is required for Apache to work. We've include the `.htaccess` file in the `public` folder. If rewriting is not working for you, please check that the `mod_rewrite` module (htaccess support) is enabled in the Apache configuration.
|
|
||||||
|
|
||||||
## Folder structure
|
|
||||||
|
|
||||||
| Folder | Description |
|
|
||||||
| ------------- |-------------|
|
|
||||||
| app |Contains projects-specific PHP classes|
|
|
||||||
| public |Public folder which are accessible through the web.|
|
|
||||||
|
|
||||||
## Notes
|
|
||||||
|
|
||||||
The demo project has it's own `Router` class implementation which extends the `SimpleRouter` class with further functionality.
|
|
||||||
This class can be useful adding additional functionality that are required before and after routing occurs or any extra functionality belonging to the router itself.
|
|
||||||
|
|
||||||
In this project we also use our custom router-class to autoload the `routes.php` file from our custom location (`app/routes.php`).
|
|
||||||
|
|
||||||
Please check the `routes.php` file in `demo-project/app` for all the urls/rules available in the project.
|
|
||||||
|
|
||||||
### CSRF-verifier
|
|
||||||
|
|
||||||
For the purpose of this demo, we've added a custom CSRF-verifier middleware called `CsrfVerifier` and disabled CSRF checks for all calls to `/api/*`. This will ensure that CSRF form-checks are not applied when calling our demo api url.
|
|
||||||
|
|
||||||
### Exception handlers
|
|
||||||
|
|
||||||
The included `CustomExceptionHandler` class returns a very basic json response for errors received on calls to `/api/*` or otherwise just a simple formatted error response.
|
|
||||||
|
|
||||||
### Middlewares
|
|
||||||
|
|
||||||
`ApiVerification` class is added to all calls to `/api/*`. This simple class just adds some data to the `Request` object, which is returned in one of the methods in the `ApiController` class. We've added this class to demonstrate that you can use middlewares to ensure that the user has the correct authentication - before router loads the controller itself.
|
|
||||||
|
|
||||||
### Urls
|
|
||||||
|
|
||||||
Please see `routes.php` for all routes and rules.
|
|
||||||
|
|
||||||
| URL |
|
|
||||||
| ------------- |
|
|
||||||
| / |
|
|
||||||
| /api/demo |
|
|
||||||
| /companies |
|
|
||||||
| /companies/[id] |
|
|
||||||
| /contact |
|
|
||||||
|
|
||||||
## The MIT License (MIT)
|
|
||||||
|
|
||||||
Copyright (c) 2016 Simon Sessingø / simple-php-router
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
|
||||||
in the Software without restriction, including without limitation the rights
|
|
||||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
||||||
copies of the Software, and to permit persons to whom the Software is
|
|
||||||
furnished to do so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in all
|
|
||||||
copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
||||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
||||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
||||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
||||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
||||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
||||||
SOFTWARE.
|
|
||||||
@@ -1,16 +0,0 @@
|
|||||||
<?php
|
|
||||||
namespace Demo\Controllers;
|
|
||||||
|
|
||||||
class ApiController
|
|
||||||
{
|
|
||||||
public function index()
|
|
||||||
{
|
|
||||||
// The variable authenticated is set to true in the ApiVerification middleware class.
|
|
||||||
header('content-type: application/json');
|
|
||||||
|
|
||||||
echo json_encode([
|
|
||||||
'authenticated' => request()->authenticated
|
|
||||||
]);
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
<?php
|
|
||||||
namespace Demo\Controllers;
|
|
||||||
|
|
||||||
class DefaultController
|
|
||||||
{
|
|
||||||
public function index()
|
|
||||||
{
|
|
||||||
// implement
|
|
||||||
echo sprintf('DefaultController -> index (?fun=%s)', input()->get('fun'));
|
|
||||||
}
|
|
||||||
|
|
||||||
public function contact()
|
|
||||||
{
|
|
||||||
echo 'DefaultController -> contact';
|
|
||||||
}
|
|
||||||
|
|
||||||
public function companies($id = null)
|
|
||||||
{
|
|
||||||
echo 'DefaultController -> companies -> id: ' . $id;
|
|
||||||
}
|
|
||||||
|
|
||||||
public function notFound()
|
|
||||||
{
|
|
||||||
echo 'Page not found';
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
||||||
@@ -1,44 +0,0 @@
|
|||||||
<?php
|
|
||||||
namespace Demo\Handlers;
|
|
||||||
|
|
||||||
use Pecee\Handlers\IExceptionHandler;
|
|
||||||
use Pecee\Http\Request;
|
|
||||||
use Pecee\SimpleRouter\Exceptions\NotFoundHttpException;
|
|
||||||
use Pecee\SimpleRouter\Route\ILoadableRoute;
|
|
||||||
|
|
||||||
class CustomExceptionHandler implements IExceptionHandler
|
|
||||||
{
|
|
||||||
public function handleError(Request $request, ILoadableRoute &$route = null, \Exception $error)
|
|
||||||
{
|
|
||||||
|
|
||||||
/* You can use the exception handler to format errors depending on the request and type. */
|
|
||||||
|
|
||||||
if (stripos($request->getUri(), '/api') !== false) {
|
|
||||||
|
|
||||||
response()->json([
|
|
||||||
'error' => $error->getMessage(),
|
|
||||||
'code' => $error->getCode(),
|
|
||||||
]);
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
/* The router will throw the NotFoundHttpException on 404 */
|
|
||||||
if($error instanceof NotFoundHttpException) {
|
|
||||||
|
|
||||||
/*
|
|
||||||
* Render your own custom 404-view, rewrite the request to another route,
|
|
||||||
* or simply return the $request object to ignore the error and continue on rendering the route.
|
|
||||||
*
|
|
||||||
* The code below will make the router render our page.notfound route.
|
|
||||||
*/
|
|
||||||
|
|
||||||
$request->setUri(url('page.notfound'));
|
|
||||||
return $request;
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
throw $error;
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
<?php
|
|
||||||
namespace Demo\Middlewares;
|
|
||||||
|
|
||||||
use Pecee\Http\Middleware\IMiddleware;
|
|
||||||
use Pecee\Http\Request;
|
|
||||||
use Pecee\SimpleRouter\Route\ILoadableRoute;
|
|
||||||
|
|
||||||
class ApiVerification implements IMiddleware
|
|
||||||
{
|
|
||||||
public function handle(Request $request, ILoadableRoute &$route)
|
|
||||||
{
|
|
||||||
// Do authentication
|
|
||||||
$request->authenticated = true;
|
|
||||||
|
|
||||||
return $request;
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
<?php
|
|
||||||
namespace Demo\Middlewares;
|
|
||||||
|
|
||||||
use Pecee\Http\Middleware\BaseCsrfVerifier;
|
|
||||||
|
|
||||||
class CsrfVerifier extends BaseCsrfVerifier
|
|
||||||
{
|
|
||||||
/**
|
|
||||||
* CSRF validation will be ignored on the following urls.
|
|
||||||
*/
|
|
||||||
protected $except = ['/api/*'];
|
|
||||||
|
|
||||||
}
|
|
||||||
@@ -1,26 +0,0 @@
|
|||||||
<?php
|
|
||||||
/**
|
|
||||||
* Custom router which handles default middlewares, default exceptions and things
|
|
||||||
* that should be happen before and after the router is initialised.
|
|
||||||
*/
|
|
||||||
namespace Demo;
|
|
||||||
|
|
||||||
use Pecee\SimpleRouter\SimpleRouter;
|
|
||||||
|
|
||||||
class Router extends SimpleRouter
|
|
||||||
{
|
|
||||||
public static function start($defaultNamespace = null)
|
|
||||||
{
|
|
||||||
// Load our helpers
|
|
||||||
require_once 'helpers.php';
|
|
||||||
|
|
||||||
// Load our custom routes
|
|
||||||
require_once 'routes.php';
|
|
||||||
|
|
||||||
parent::setDefaultNamespace('\Demo');
|
|
||||||
|
|
||||||
// Do initial stuff
|
|
||||||
parent::start();
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
||||||
@@ -1,44 +0,0 @@
|
|||||||
<?php
|
|
||||||
use Pecee\SimpleRouter\SimpleRouter;
|
|
||||||
|
|
||||||
function url($controller, $parameters = null, $getParams = null)
|
|
||||||
{
|
|
||||||
SimpleRouter::getUrl($controller, $parameters, $getParams);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get current csrf-token
|
|
||||||
* @return null|string
|
|
||||||
*/
|
|
||||||
function csrf_token()
|
|
||||||
{
|
|
||||||
$token = new \Pecee\CsrfToken();
|
|
||||||
return $token->getToken();
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get request object
|
|
||||||
* @return \Pecee\Http\Request
|
|
||||||
*/
|
|
||||||
function request()
|
|
||||||
{
|
|
||||||
return SimpleRouter::request();
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get response object
|
|
||||||
* @return \Pecee\Http\Response
|
|
||||||
*/
|
|
||||||
function response()
|
|
||||||
{
|
|
||||||
return SimpleRouter::response();
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get input class
|
|
||||||
* @return \Pecee\Http\Input\Input
|
|
||||||
*/
|
|
||||||
function input()
|
|
||||||
{
|
|
||||||
return SimpleRouter::request()->getInput();
|
|
||||||
}
|
|
||||||
@@ -1,25 +0,0 @@
|
|||||||
<?php
|
|
||||||
/**
|
|
||||||
* This file contains all the routes for the project
|
|
||||||
*/
|
|
||||||
|
|
||||||
use Demo\Router;
|
|
||||||
|
|
||||||
Router::csrfVerifier(new \Demo\Middlewares\CsrfVerifier());
|
|
||||||
|
|
||||||
Router::group(['exceptionHandler' => 'Demo\Handlers\CustomExceptionHandler'], function () {
|
|
||||||
|
|
||||||
Router::get('/', 'DefaultController@index')->setName('home');
|
|
||||||
|
|
||||||
Router::get('/contact', 'DefaultController@contact')->setName('contact');
|
|
||||||
|
|
||||||
Router::get('/404', 'DefaultController@notFound')->setName('404');
|
|
||||||
|
|
||||||
Router::basic('/companies/{id?}', 'DefaultController@companies')->setName('companies');
|
|
||||||
|
|
||||||
// Api
|
|
||||||
Router::group(['prefix' => '/api', 'middleware' => 'Demo\Middlewares\ApiVerification'], function () {
|
|
||||||
Router::resource('/demo', 'ApiController');
|
|
||||||
});
|
|
||||||
|
|
||||||
});
|
|
||||||
@@ -1,26 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "pecee/simple-router-demo",
|
|
||||||
"description": "Simple router demo project",
|
|
||||||
"keywords": [
|
|
||||||
"simple-router",
|
|
||||||
"php",
|
|
||||||
"php-simple-router"
|
|
||||||
],
|
|
||||||
"license": "MIT",
|
|
||||||
"type": "project",
|
|
||||||
"require": {
|
|
||||||
"php": ">=5.4.0",
|
|
||||||
"pecee/simple-router": "2.*"
|
|
||||||
},
|
|
||||||
"require-dev": {
|
|
||||||
|
|
||||||
},
|
|
||||||
"config": {
|
|
||||||
"preferred-install": "dist"
|
|
||||||
},
|
|
||||||
"autoload": {
|
|
||||||
"psr-4": {
|
|
||||||
"Demo\\": "app/"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,5 +0,0 @@
|
|||||||
RewriteEngine on
|
|
||||||
RewriteCond %{SCRIPT_FILENAME} !-f
|
|
||||||
RewriteCond %{SCRIPT_FILENAME} !-d
|
|
||||||
RewriteCond %{SCRIPT_FILENAME} !-l
|
|
||||||
RewriteRule ^(.*)$ index.php/$1
|
|
||||||
@@ -1,7 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
// load composer dependencies
|
|
||||||
require '../vendor/autoload.php';
|
|
||||||
|
|
||||||
// Start the routing
|
|
||||||
\Demo\Router::start();
|
|
||||||
@@ -0,0 +1,15 @@
|
|||||||
|
<?php
|
||||||
|
namespace Pecee\Http\Input;
|
||||||
|
|
||||||
|
interface IInputItem
|
||||||
|
{
|
||||||
|
|
||||||
|
public function getIndex();
|
||||||
|
|
||||||
|
public function getName();
|
||||||
|
|
||||||
|
public function getValue();
|
||||||
|
|
||||||
|
public function __toString();
|
||||||
|
|
||||||
|
}
|
||||||
@@ -6,19 +6,19 @@ use Pecee\Http\Request;
|
|||||||
class Input
|
class Input
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
* @var \Pecee\Http\Input\InputCollection
|
* @var array
|
||||||
*/
|
*/
|
||||||
public $get;
|
public $get = [];
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @var \Pecee\Http\Input\InputCollection
|
* @var array
|
||||||
*/
|
*/
|
||||||
public $post;
|
public $post = [];
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @var \Pecee\Http\Input\InputCollection
|
* @var array
|
||||||
*/
|
*/
|
||||||
public $file;
|
public $file = [];
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @var Request
|
* @var Request
|
||||||
@@ -36,10 +36,6 @@ class Input
|
|||||||
{
|
{
|
||||||
$this->request = $request;
|
$this->request = $request;
|
||||||
|
|
||||||
$this->post = new InputCollection();
|
|
||||||
$this->get = new InputCollection();
|
|
||||||
$this->file = new InputCollection();
|
|
||||||
|
|
||||||
if ($request->getMethod() !== 'get') {
|
if ($request->getMethod() !== 'get') {
|
||||||
|
|
||||||
$requestContentType = $request->getHeader('http-content-type');
|
$requestContentType = $request->getHeader('http-content-type');
|
||||||
@@ -60,29 +56,17 @@ class Input
|
|||||||
if ($this->invalidContentType === false) {
|
if ($this->invalidContentType === false) {
|
||||||
$this->parseInputs();
|
$this->parseInputs();
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
protected function parseInputs()
|
protected function parseInputs()
|
||||||
{
|
{
|
||||||
/* Parse get requests */
|
/* Parse get requests */
|
||||||
|
|
||||||
if (count($_GET) > 0) {
|
if (count($_GET) > 0) {
|
||||||
|
$this->get = $this->handleGetPost($_GET);
|
||||||
$max = count($_GET) - 1;
|
|
||||||
$keys = array_keys($_GET);
|
|
||||||
|
|
||||||
for ($i = $max; $i >= 0; $i--) {
|
|
||||||
|
|
||||||
$key = $keys[$i];
|
|
||||||
$value = $_GET[$key];
|
|
||||||
|
|
||||||
$this->get->{$key} = new InputItem($key, $value);
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/* Parse post requests */
|
/* Parse post requests */
|
||||||
|
|
||||||
$postVars = $_POST;
|
$postVars = $_POST;
|
||||||
|
|
||||||
if (in_array($this->request->getMethod(), ['put', 'patch', 'delete']) === true) {
|
if (in_array($this->request->getMethod(), ['put', 'patch', 'delete']) === true) {
|
||||||
@@ -90,18 +74,7 @@ class Input
|
|||||||
}
|
}
|
||||||
|
|
||||||
if (count($postVars) > 0) {
|
if (count($postVars) > 0) {
|
||||||
|
$this->post = $this->handleGetPost($postVars);
|
||||||
$max = count($postVars) - 1;
|
|
||||||
$keys = array_keys($postVars);
|
|
||||||
|
|
||||||
for ($i = $max; $i >= 0; $i--) {
|
|
||||||
|
|
||||||
$key = $keys[$i];
|
|
||||||
$value = $postVars[$key];
|
|
||||||
|
|
||||||
$this->post->{strtolower($key)} = new InputItem($key, $value);
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/* Parse get requests */
|
/* Parse get requests */
|
||||||
@@ -119,56 +92,96 @@ class Input
|
|||||||
// Handle array input
|
// Handle array input
|
||||||
if (is_array($value['name']) === false) {
|
if (is_array($value['name']) === false) {
|
||||||
$values['index'] = $key;
|
$values['index'] = $key;
|
||||||
$this->file->{strtolower($key)} = InputFile::createFromArray($values);
|
$this->file[$key] = InputFile::createFromArray(array_merge($value, $values));
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
|
||||||
$output = new InputCollection();
|
$subMax = count($value['name']) - 1;
|
||||||
|
$keys = array_keys($value['name']);
|
||||||
|
$output = [];
|
||||||
|
|
||||||
foreach ($value['name'] as $k => $val) {
|
for ($i = $subMax; $i >= 0; $i--) {
|
||||||
|
|
||||||
$output->{$k} = InputFile::createFromArray([
|
$output[$keys[$i]] = InputFile::createFromArray([
|
||||||
'index' => $key,
|
'index' => $key,
|
||||||
'error' => $value['error'][$k],
|
'error' => $value['error'][$keys[$i]],
|
||||||
'tmp_name' => $value['tmp_name'][$k],
|
'tmp_name' => $value['tmp_name'][$keys[$i]],
|
||||||
'type' => $value['type'][$k],
|
'type' => $value['type'][$keys[$i]],
|
||||||
'size' => $value['size'][$k],
|
'size' => $value['size'][$keys[$i]],
|
||||||
'name' => $value['name'][$k],
|
'name' => $value['name'][$keys[$i]],
|
||||||
]);
|
]);
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
$this->file->{strtolower($key)} = $output;
|
$this->file[$key] = $output;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
public function getObject($index, $default = null)
|
protected function handleGetPost($array)
|
||||||
{
|
{
|
||||||
$key = (strpos($index, '[') > -1) ? substr($index, strpos($index, '[') + 1, strpos($index, ']') - strlen($index)) : null;
|
$tmp = [];
|
||||||
$index = (strpos($index, '[') > -1) ? substr($index, 0, strpos($index, '[')) : $index;
|
|
||||||
|
|
||||||
$element = $this->get->findFirst($index);
|
$max = count($array) - 1;
|
||||||
|
$keys = array_keys($array);
|
||||||
|
|
||||||
if ($element !== null) {
|
for ($i = $max; $i >= 0; $i--) {
|
||||||
return ($key !== null) ? $element[$key] : $element;
|
|
||||||
}
|
|
||||||
|
|
||||||
if ($this->request->getMethod() !== 'get') {
|
$key = $keys[$i];
|
||||||
|
$value = $array[$key];
|
||||||
|
|
||||||
$element = $this->post->findFirst($index);
|
// Handle array input
|
||||||
if ($element !== null) {
|
if (is_array($value) === false) {
|
||||||
return ($key !== null) ? $element[$key] : $element;
|
$tmp[$key] = new InputItem($key, $value);
|
||||||
|
continue;
|
||||||
}
|
}
|
||||||
|
|
||||||
$element = $this->file->findFirst($index);
|
$subMax = count($value) - 1;
|
||||||
if ($element !== null) {
|
$keys = array_keys($value);
|
||||||
return ($key !== null) ? $element[$key] : $element;
|
$output = [];
|
||||||
|
|
||||||
|
for ($i = $subMax; $i >= 0; $i--) {
|
||||||
|
$output[$keys[$i]] = new InputItem($key, $value[$keys[$i]]);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
$tmp[$key] = $output;
|
||||||
}
|
}
|
||||||
|
|
||||||
return $default;
|
return $tmp;
|
||||||
|
}
|
||||||
|
|
||||||
|
public function findPost($index, $default = null)
|
||||||
|
{
|
||||||
|
return isset($this->post[$index]) ? $this->post[$index] : $default;
|
||||||
|
}
|
||||||
|
|
||||||
|
public function findFile($index, $default = null)
|
||||||
|
{
|
||||||
|
return isset($this->file[$index]) ? $this->file[$index] : $default;
|
||||||
|
}
|
||||||
|
|
||||||
|
public function findGet($index, $default = null)
|
||||||
|
{
|
||||||
|
return isset($this->get[$index]) ? $this->get[$index] : $default;
|
||||||
|
}
|
||||||
|
|
||||||
|
public function getObject($index, $default = null, $method = null)
|
||||||
|
{
|
||||||
|
$element = null;
|
||||||
|
|
||||||
|
if ($method === null || strtolower($method) === 'get') {
|
||||||
|
$element = $this->findGet($index);
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($element === null && $method === null || strtolower($method) === 'post') {
|
||||||
|
$element = $this->findPost($index);
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($element === null && $method === null || strtolower($method) === 'file') {
|
||||||
|
$element = $this->findFile($index);
|
||||||
|
}
|
||||||
|
|
||||||
|
return ($element === null) ? $default : $element;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -176,22 +189,18 @@ class Input
|
|||||||
*
|
*
|
||||||
* @param string $index
|
* @param string $index
|
||||||
* @param string|null $default
|
* @param string|null $default
|
||||||
|
* @param string|null $method
|
||||||
* @return InputItem|string
|
* @return InputItem|string
|
||||||
*/
|
*/
|
||||||
public function get($index, $default = null)
|
public function get($index, $default = null, $method = null)
|
||||||
{
|
{
|
||||||
$item = $this->getObject($index);
|
$input = $this->getObject($index, $default, $method);
|
||||||
|
|
||||||
if ($item !== null) {
|
if ($input instanceof InputItem) {
|
||||||
|
return (trim($input->getValue()) === '') ? $default : $input->getValue();
|
||||||
if ($item instanceof InputCollection || $item instanceof InputFile) {
|
|
||||||
return $item;
|
|
||||||
}
|
|
||||||
|
|
||||||
return (!is_array($item->getValue()) && trim($item->getValue()) === '') ? $default : $item;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return $default;
|
return $input;
|
||||||
}
|
}
|
||||||
|
|
||||||
public function exists($index)
|
public function exists($index)
|
||||||
|
|||||||
@@ -1,91 +0,0 @@
|
|||||||
<?php
|
|
||||||
namespace Pecee\Http\Input;
|
|
||||||
|
|
||||||
class InputCollection implements \IteratorAggregate
|
|
||||||
{
|
|
||||||
protected $data = [];
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Search for input element matching index.
|
|
||||||
*
|
|
||||||
* @param string $index
|
|
||||||
* @param string|null $default
|
|
||||||
* @return InputItem|mixed
|
|
||||||
*/
|
|
||||||
public function findFirst($index, $default = null)
|
|
||||||
{
|
|
||||||
if (count($this->data) > 0) {
|
|
||||||
|
|
||||||
if (isset($this->data[$index])) {
|
|
||||||
return $this->data[$index];
|
|
||||||
}
|
|
||||||
|
|
||||||
foreach ($this->data as $key => $input) {
|
|
||||||
if (strtolower($index) === strtolower($key)) {
|
|
||||||
return $input;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return $default;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get input element value matching index
|
|
||||||
*
|
|
||||||
* @param string $index
|
|
||||||
* @param string|null $default
|
|
||||||
* @return string|null
|
|
||||||
*/
|
|
||||||
public function get($index, $default = null)
|
|
||||||
{
|
|
||||||
$input = $this->findFirst($index);
|
|
||||||
|
|
||||||
if ($input !== null && trim($input->getValue()) !== '') {
|
|
||||||
return $input->getValue();
|
|
||||||
}
|
|
||||||
|
|
||||||
return $default;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param string $index
|
|
||||||
* @throws \InvalidArgumentException
|
|
||||||
* @return InputItem
|
|
||||||
*/
|
|
||||||
public function __get($index)
|
|
||||||
{
|
|
||||||
$item = $this->findFirst($index);
|
|
||||||
// Ensure that item are always available
|
|
||||||
if ($item === null) {
|
|
||||||
$this->data[$index] = new InputItem($index, null);
|
|
||||||
|
|
||||||
return $this->data[$index];
|
|
||||||
}
|
|
||||||
|
|
||||||
return $item;
|
|
||||||
}
|
|
||||||
|
|
||||||
public function __set($index, $value)
|
|
||||||
{
|
|
||||||
$this->data[$index] = $value;
|
|
||||||
}
|
|
||||||
|
|
||||||
public function getData()
|
|
||||||
{
|
|
||||||
return $this->data;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Retrieve an external iterator
|
|
||||||
* @link http://php.net/manual/en/iteratoraggregate.getiterator.php
|
|
||||||
* @return \Traversable An instance of an object implementing <b>Iterator</b> or
|
|
||||||
* <b>Traversable</b>
|
|
||||||
* @since 5.0.0
|
|
||||||
*/
|
|
||||||
public function getIterator()
|
|
||||||
{
|
|
||||||
return new \ArrayIterator($this->data);
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
||||||
@@ -1,13 +1,39 @@
|
|||||||
<?php
|
<?php
|
||||||
namespace Pecee\Http\Input;
|
namespace Pecee\Http\Input;
|
||||||
|
|
||||||
class InputFile extends InputItem
|
class InputFile implements IInputItem
|
||||||
{
|
{
|
||||||
|
public $index;
|
||||||
|
public $name;
|
||||||
public $size;
|
public $size;
|
||||||
public $type;
|
public $type;
|
||||||
public $error;
|
public $error;
|
||||||
public $tmpName;
|
public $tmpName;
|
||||||
|
|
||||||
|
public function __construct($index)
|
||||||
|
{
|
||||||
|
$this->index = $index;
|
||||||
|
|
||||||
|
// Make the name human friendly, by replace _ with space
|
||||||
|
$this->name = ucfirst(str_replace('_', ' ', $this->index));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getIndex()
|
||||||
|
{
|
||||||
|
return $this->index;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getName()
|
||||||
|
{
|
||||||
|
return $this->name;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return string
|
* @return string
|
||||||
*/
|
*/
|
||||||
@@ -60,6 +86,13 @@ class InputFile extends InputItem
|
|||||||
return file_get_contents($this->tmpName);
|
return file_get_contents($this->tmpName);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public function setName($name)
|
||||||
|
{
|
||||||
|
$this->name = $name;
|
||||||
|
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set file temp. name
|
* Set file temp. name
|
||||||
* @param string $name
|
* @param string $name
|
||||||
@@ -68,6 +101,7 @@ class InputFile extends InputItem
|
|||||||
public function setTmpName($name)
|
public function setTmpName($name)
|
||||||
{
|
{
|
||||||
$this->tmpName = $name;
|
$this->tmpName = $name;
|
||||||
|
|
||||||
return $this;
|
return $this;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -79,6 +113,7 @@ class InputFile extends InputItem
|
|||||||
public function setSize($size)
|
public function setSize($size)
|
||||||
{
|
{
|
||||||
$this->size = $size;
|
$this->size = $size;
|
||||||
|
|
||||||
return $this;
|
return $this;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -90,6 +125,7 @@ class InputFile extends InputItem
|
|||||||
public function setType($type)
|
public function setType($type)
|
||||||
{
|
{
|
||||||
$this->type = $type;
|
$this->type = $type;
|
||||||
|
|
||||||
return $this;
|
return $this;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -101,6 +137,7 @@ class InputFile extends InputItem
|
|||||||
public function setError($error)
|
public function setError($error)
|
||||||
{
|
{
|
||||||
$this->error = (int)$error;
|
$this->error = (int)$error;
|
||||||
|
|
||||||
return $this;
|
return $this;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -109,7 +146,8 @@ class InputFile extends InputItem
|
|||||||
return $this->getTmpName();
|
return $this->getTmpName();
|
||||||
}
|
}
|
||||||
|
|
||||||
public function hasError() {
|
public function hasError()
|
||||||
|
{
|
||||||
return ($this->getError() !== 0);
|
return ($this->getError() !== 0);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -120,28 +158,33 @@ class InputFile extends InputItem
|
|||||||
*/
|
*/
|
||||||
public static function createFromArray(array $values)
|
public static function createFromArray(array $values)
|
||||||
{
|
{
|
||||||
if(!isset($values['index'])) {
|
if (!isset($values['index'])) {
|
||||||
throw new \InvalidArgumentException('Index key is required');
|
throw new \InvalidArgumentException('Index key is required');
|
||||||
}
|
}
|
||||||
|
|
||||||
$input = new static($values['index']);
|
$input = new static($values['index']);
|
||||||
$input->setError((isset($values['error']) ? $values['error'] : null));
|
$input->setError(isset($values['error']) ? $values['error'] : null);
|
||||||
$input->setName((isset($values['name']) ? $values['name'] : null));
|
$input->setName(isset($values['name']) ? $values['name'] : null);
|
||||||
$input->setSize((isset($values['size']) ? $values['size'] : null));
|
$input->setSize(isset($values['size']) ? $values['size'] : null);
|
||||||
$input->setType((isset($values['type']) ? $values['type'] : null));
|
$input->setType(isset($values['type']) ? $values['type'] : null);
|
||||||
$input->setTmpName((isset($values['tmp_name']) ? $values['tmp_name'] : null));
|
$input->setTmpName(isset($values['tmp_name']) ? $values['tmp_name'] : null);
|
||||||
|
|
||||||
return $input;
|
return $input;
|
||||||
}
|
}
|
||||||
|
|
||||||
public function toArray() {
|
public function toArray()
|
||||||
|
{
|
||||||
return [
|
return [
|
||||||
'tmp_name' => $this->tmpName,
|
'tmp_name' => $this->tmpName,
|
||||||
'type' => $this->type,
|
'type' => $this->type,
|
||||||
'size' => $this->size,
|
'size' => $this->size,
|
||||||
'name' => $this->name,
|
'name' => $this->name,
|
||||||
'error' => $this->error,
|
'error' => $this->error,
|
||||||
];
|
];
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public function __toString()
|
||||||
|
{
|
||||||
|
return $this->getValue();
|
||||||
|
}
|
||||||
}
|
}
|
||||||
@@ -1,7 +1,7 @@
|
|||||||
<?php
|
<?php
|
||||||
namespace Pecee\Http\Input;
|
namespace Pecee\Http\Input;
|
||||||
|
|
||||||
class InputItem
|
class InputItem implements IInputItem
|
||||||
{
|
{
|
||||||
public $index;
|
public $index;
|
||||||
public $name;
|
public $name;
|
||||||
@@ -16,6 +16,14 @@ class InputItem
|
|||||||
$this->name = ucfirst(str_replace('_', ' ', $this->index));
|
$this->name = ucfirst(str_replace('_', ' ', $this->index));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getIndex()
|
||||||
|
{
|
||||||
|
return $this->index;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return string
|
* @return string
|
||||||
*/
|
*/
|
||||||
@@ -32,14 +40,6 @@ class InputItem
|
|||||||
return $this->value;
|
return $this->value;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* @return string
|
|
||||||
*/
|
|
||||||
public function getIndex()
|
|
||||||
{
|
|
||||||
return $this->index;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set input name
|
* Set input name
|
||||||
* @param string $name
|
* @param string $name
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ class BaseCsrfVerifier implements IMiddleware
|
|||||||
$this->csrfToken = new CsrfToken();
|
$this->csrfToken = new CsrfToken();
|
||||||
|
|
||||||
// Generate or get the CSRF-Token from Cookie.
|
// Generate or get the CSRF-Token from Cookie.
|
||||||
$this->token = (!$this->hasToken()) ? $this->generateToken() : $this->csrfToken->getToken();
|
$this->token = ($this->hasToken() === false) ? $this->generateToken() : $this->csrfToken->getToken();
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -34,7 +34,11 @@ class BaseCsrfVerifier implements IMiddleware
|
|||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
foreach ($this->except as $url) {
|
$max = count($this->except) - 1;
|
||||||
|
|
||||||
|
for ($i = $max; $i >= 0; $i--) {
|
||||||
|
$url = $this->except[$i];
|
||||||
|
|
||||||
$url = rtrim($url, '/');
|
$url = rtrim($url, '/');
|
||||||
if ($url[strlen($url) - 1] === '*') {
|
if ($url[strlen($url) - 1] === '*') {
|
||||||
$url = rtrim($url, '*');
|
$url = rtrim($url, '*');
|
||||||
@@ -43,7 +47,7 @@ class BaseCsrfVerifier implements IMiddleware
|
|||||||
$skip = ($url === rtrim($request->getUri(), '/'));
|
$skip = ($url === rtrim($request->getUri(), '/'));
|
||||||
}
|
}
|
||||||
|
|
||||||
if ($skip) {
|
if ($skip === true) {
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -54,16 +58,16 @@ class BaseCsrfVerifier implements IMiddleware
|
|||||||
public function handle(Request $request, ILoadableRoute &$route = null)
|
public function handle(Request $request, ILoadableRoute &$route = null)
|
||||||
{
|
{
|
||||||
|
|
||||||
if ($request->getMethod() !== 'get' && !$this->skip($request)) {
|
if (in_array($request->getMethod(), ['post', 'put', 'delete']) === true && $this->skip($request) === false) {
|
||||||
|
|
||||||
$token = $request->getInput()->post->get(static::POST_KEY);
|
$token = $request->getInput()->get(static::POST_KEY, null, 'post');
|
||||||
|
|
||||||
// If the token is not posted, check headers for valid x-csrf-token
|
// If the token is not posted, check headers for valid x-csrf-token
|
||||||
if ($token === null) {
|
if ($token === null) {
|
||||||
$token = $request->getHeader(static::HEADER_KEY);
|
$token = $request->getHeader(static::HEADER_KEY);
|
||||||
}
|
}
|
||||||
|
|
||||||
if (!$this->csrfToken->validate($token)) {
|
if ($this->csrfToken->validate($token) === false) {
|
||||||
throw new TokenMismatchException('Invalid csrf-token.');
|
throw new TokenMismatchException('Invalid csrf-token.');
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ class Request
|
|||||||
$this->parseHeaders();
|
$this->parseHeaders();
|
||||||
$this->host = $this->getHeader('http-host');;
|
$this->host = $this->getHeader('http-host');;
|
||||||
$this->uri = $this->getHeader('request-uri');
|
$this->uri = $this->getHeader('request-uri');
|
||||||
$this->method = strtolower($this->getHeader('request-method'));
|
$this->method = $this->input->get('_method', strtolower($this->getHeader('request-method')));
|
||||||
$this->input = new Input($this);
|
$this->input = new Input($this);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -25,9 +25,15 @@ class Request
|
|||||||
{
|
{
|
||||||
$this->headers = [];
|
$this->headers = [];
|
||||||
|
|
||||||
foreach ($_SERVER as $name => $value) {
|
$max = count($_SERVER) - 1;
|
||||||
$this->headers[strtolower($name)] = $value;
|
$keys = array_keys($_SERVER);
|
||||||
$this->headers[strtolower(str_replace('_', '-', $name))] = $value;
|
|
||||||
|
for($i = $max; $i >= 0; $i--) {
|
||||||
|
$key = $keys[$i];
|
||||||
|
$value = $_SERVER[$key];
|
||||||
|
|
||||||
|
$this->headers[strtolower($key)] = $value;
|
||||||
|
$this->headers[strtolower(str_replace('_', '-', $key))] = $value;
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -59,7 +59,12 @@ class RouteController extends LoadableRoute implements IControllerRoute
|
|||||||
|
|
||||||
/* Remove requestType from method-name, if it exists */
|
/* Remove requestType from method-name, if it exists */
|
||||||
if ($method !== null) {
|
if ($method !== null) {
|
||||||
foreach (static::$requestTypes as $requestType) {
|
$max = count(static::$requestTypes);
|
||||||
|
|
||||||
|
for ($i = 0; $i < $max; $i++) {
|
||||||
|
|
||||||
|
$requestType = static::$requestTypes[$i];
|
||||||
|
|
||||||
if (stripos($method, $requestType) === 0) {
|
if (stripos($method, $requestType) === 0) {
|
||||||
$method = substr($method, strlen($requestType));
|
$method = substr($method, strlen($requestType));
|
||||||
break;
|
break;
|
||||||
|
|||||||
@@ -19,8 +19,12 @@ class RouteGroup extends Route implements IGroupRoute
|
|||||||
public function matchDomain(Request $request)
|
public function matchDomain(Request $request)
|
||||||
{
|
{
|
||||||
if (count($this->domains) > 0) {
|
if (count($this->domains) > 0) {
|
||||||
foreach ($this->domains as $domain) {
|
|
||||||
|
|
||||||
|
$max = count($this->domains);
|
||||||
|
|
||||||
|
for ($i = 0; $i < $max; $i++) {
|
||||||
|
|
||||||
|
$domain = $this->domains[$i];
|
||||||
$parameters = $this->parseParameters($domain, $request->getHost(), '.*');
|
$parameters = $this->parseParameters($domain, $request->getHost(), '.*');
|
||||||
|
|
||||||
if ($parameters !== null) {
|
if ($parameters !== null) {
|
||||||
|
|||||||
@@ -19,8 +19,12 @@ class RouteUrl extends LoadableRoute
|
|||||||
// Match on custom defined regular expression
|
// Match on custom defined regular expression
|
||||||
if ($this->regex !== null) {
|
if ($this->regex !== null) {
|
||||||
$parameters = [];
|
$parameters = [];
|
||||||
if (preg_match('/(' . $this->regex . ')/is', $request->getHost() . $url, $parameters)) {
|
if (preg_match($this->regex, $request->getHost() . $url, $parameters)) {
|
||||||
$this->parameters = (array)$parameters[0];
|
/* Remove global match */
|
||||||
|
if(count($parameters) > 1) {
|
||||||
|
array_shift($parameters);
|
||||||
|
$this->parameters = $parameters;
|
||||||
|
}
|
||||||
|
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -140,8 +140,12 @@ class Router
|
|||||||
protected function processRoutes(array $routes, IGroupRoute $group = null, IRoute $parent = null)
|
protected function processRoutes(array $routes, IGroupRoute $group = null, IRoute $parent = null)
|
||||||
{
|
{
|
||||||
// Loop through each route-request
|
// Loop through each route-request
|
||||||
|
$max = count($routes) - 1;
|
||||||
|
|
||||||
/* @var $route IRoute */
|
/* @var $route IRoute */
|
||||||
foreach ($routes as $route) {
|
for ($i = $max; $i >= 0; $i--) {
|
||||||
|
|
||||||
|
$route = $routes[$i];
|
||||||
|
|
||||||
if ($route instanceof IGroupRoute) {
|
if ($route instanceof IGroupRoute) {
|
||||||
|
|
||||||
@@ -238,10 +242,10 @@ class Router
|
|||||||
$this->originalUrl = $this->request->getUri();
|
$this->originalUrl = $this->request->getUri();
|
||||||
}
|
}
|
||||||
|
|
||||||
$max = count($this->processedRoutes);
|
$max = count($this->processedRoutes) - 1;
|
||||||
|
|
||||||
/* @var $route IRoute */
|
/* @var $route IRoute */
|
||||||
for ($i = 0; $i < $max; $i++) {
|
for ($i = $max; $i >= 0; $i--) {
|
||||||
|
|
||||||
$route = $this->processedRoutes[$i];
|
$route = $this->processedRoutes[$i];
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user