josephjlee / php-router Goto Github PK

Router

  _____  _    _ _____             _____             _            
 |  __ \| |  | |  __ \           |  __ \           | |           
 | |__) | |__| | |__) |  ______  | |__) |___  _   _| |_ ___ _ __
 |  ___/|  __  |  ___/  |______| |  _  // _ \| | | | __/ _ \ '__|
 | |    | |  | | |               | | \ \ (_) | |_| | ||  __/ |   
 |_|    |_|  |_|_|               |_|  \_\___/ \__,_|\__\___|_|   

simple Router class for PHP. with the support of Controllers and Middlewares.

Features

• Supports GET, POST, PUT, DELETE, OPTIONS, PATCH, HEAD, AJAX and ANY request methods
• 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 handling
• Debug mode (Error message open/close)

Install

composer.json file:

{
    "require": {
        "izniburak/router": "^1"
    }
}

after run the install command.

$ composer install

OR run the following command directly.

$ composer require izniburak/router

Example Usage

require 'vendor/autoload.php';

$router = new Buki\Router();

$router->get('/', function() {
    return 'Hello World!';
});
$router->get('/controller', 'TestController@main');

$router->run();

Docs

Documentation page: Buki\Router Docs

ToDo

• Write Test
• Write Documentation

Support

izniburak's homepage

izniburak's twitter

Licence

MIT Licence

Contributing

1. Fork it ( https://github.com/izniburak/php-router/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Contributors

• izniburak İzni Burak Demirtaş - creator, maintainer