https://github.com/halilkerimi/extreemly-simple-router
Very simple PHP router that can easly be integrated on your app and easly modified to fit your needs
https://github.com/halilkerimi/extreemly-simple-router
php php-router router simple
Last synced: 5 months ago
JSON representation
Very simple PHP router that can easly be integrated on your app and easly modified to fit your needs
- Host: GitHub
- URL: https://github.com/halilkerimi/extreemly-simple-router
- Owner: halilkerimi
- License: mit
- Created: 2020-09-08T10:06:37.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2021-03-28T01:48:20.000Z (over 5 years ago)
- Last Synced: 2025-07-23T22:59:26.059Z (11 months ago)
- Topics: php, php-router, router, simple
- Language: PHP
- Homepage:
- Size: 11.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Extreemly Simple Router
This is an PHP class that can help to add router on your PHP project. Main ideas is to create PHP router as simple as it gets, that can be integrated in your project and easy to be edited for your needs.
## Usage
Import `router.php` in your project and create an instance of `Router` class.
Add route to the instance using `addRoute` method by providing:
- Route : define a route to match
- Method : method of request to apply for
- Handler : handler function that accepts array of arguments, this arry will be provided as key value pair when route matches
```PHP
//import Router class
require_once("./router.php");
//create instance of Router
$router = new \ESRouter\Router();
//define new route
$router->addRoute("/user/{name}/post/{id:[0-9]}", "get", function ($args) {
//handle request as you need
$name = $args['name'];
$id = $args['id'];
print $name.$id ;
});
//define another route
$router->addRoute("/", "get", function ($args) {
//handle request as you need
print "Welcome home" ;
});
//more routes
//...
//optional
//Setting 404 handler
$router->setE404(function(){
echo "this is 404";
});
$router->run();
```
## Defining Routes
To define route, start with `/` and for static rout use plain text example `user` or for variable use `{name}` ad it fill match anything in between `/` and `/` or end of route, in case you want to use RegEx use `{varname:RegEx}` where *name* is the name of variable and *RegEx* is a RegEx expression to match
## Matching Routes
Routes are matchef rom the first defined route to the last, if a route is matched than it will execute the handler and will stop searching for other routes.
```PHP
//Example
//In this case if we call http:///user/nameOfTheUser/post/1234
$router->addRoute("/user/{name}/post/{id:\d{4}}", "get", function ($args) {
print 'First route';
});
$router->addRoute("/user/{name}/post/{id:[0-9]}", "get", function ($args) {
print 'Second route';
});
//First Route will be called
```