Router
_____ _ _ _____ _____ _
| __ \| | | | __ \ | __ \ | |
| |__) | |__| | |__) | ______ | |__) |___ _ _| |_ ___ _ __
| ___/| __ | ___/ |______| | _ // _ \| | | | __/ _ \ '__|
| | | | | | | | | \ \ (_) | |_| | || __/ |
|_| |_| |_|_| |_| \_\___/ \__,_|\__\___|_|
PHP Router, which also has rich features like Middlewares and Controllers is simple and useful router class for PHP., (*1)
, (*2)
Features
- Supports GET, POST, PUT, DELETE, OPTIONS, PATCH, HEAD, AJAX and ANY request methods
- Easy access and manage Request and Response via
symfony/http-foundation
package.
- Controllers support (Example: HomeController@about)
- Before and after Route Middlewares support
- Static Route Patterns
- Dynamic Route Patterns
- Easy-to-use patterns
- Adding a new pattern supports. (with RegExp)
- Namespaces supports.
- Group Routing
- Custom 404 and Exception handling
- Debug mode (Error message open/close)
Install
To install PHP Router, You can run the following command directly at your project path in your console:, (*3)
$ composer require izniburak/router
OR you can add following lines into the composer.json
file manually:, (*4)
{
"require": {
"izniburak/router": "^2.0"
}
}
Then, run the following command:, (*5)
$ composer install
Example Usage
require 'vendor/autoload.php';
use Buki\Router\Router;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
$router = new Router;
// For basic GET URI
$router->get('/', function(Request $request, Response $response) {
$response->setContent('Hello World');
return $response;
# OR
# return 'Hello World!';
});
// For basic GET URI by using a Controller class.
$router->get('/test', 'TestController@main');
// For auto discovering all methods and URIs
$router->controller('/users', 'UserController');
$router->run();
Docs
Documentation page: Buki\Router Docs, (*6)
Changelogs: Buki\Router Changelogs, (*7)
Support
izniburak's homepage, (*8)
izniburak's twitter, (*9)
Licence
MIT Licence, (*10)
Contributing
- Fork it ( https://github.com/izniburak/php-router/fork )
- Create your feature branch (git checkout -b my-new-feature)
- Commit your changes (git commit -am 'Add some feature')
- Push to the branch (git push origin my-new-feature)
- Create a new Pull Request
Contributors
-
izniburak İzni Burak Demirtaş - creator, maintainer