PHP Router class

A simple Rails inspired PHP router class.

• Usage of different HTTP Methods
• REST / Resourceful routing
• Reversed routing using named routes
• Dynamic URL's: use URL segments as parameters.

Authors

• Danny van Kooten
• Jefersson Nathan

Easy to install with composer

$ composer require dannyvankooten/php-router

Usage

Friendly URL

Create a simple .htaccess file on your root directory if you're using Apache with mod_rewrite enabled.

Options +FollowSymLinks
RewriteEngineOnRewriteRule^(.*)$index.php [NC,L]

If you're using nginx, setup your server section as following:

server{listen80;server_name mydevsite.dev;root /var/www/mydevsite/public;indexindex.php;location / {try_files$uri$uri/ /index.php?$query_string;}location~\.php$ {fastcgi_split_path_info ^(.+\.php)(/.+)$; # NOTE: You should have "cgi.fix_pathinfo = 0;" in php.ini # With php5-fpm:fastcgi_pass unix:/var/run/php5-fpm.sock;fastcgi_indexindex.php;include fastcgi.conf;fastcgi_intercept_errors on;}}

This is a simple example of routers in action

<?phprequire__DIR__.'/vendor/autoload.php';
usePHPRouter\RouteCollection;
usePHPRouter\Router;
usePHPRouter\Route;
$collection = newRouteCollection();
$collection->attachRoute(newRoute('/users/', array(
'_controller' => 'someController::usersCreate',
'methods' => 'GET'
)));
$collection->attachRoute(newRoute('/', array(
'_controller' => 'someController::indexAction',
'methods' => 'GET'
)));
$router = newRouter($collection);
$router->setBasePath('/PHP-Router');
$route = $router->matchCurrentRequest();
var_dump($route);

Load routers from a yaml file

We can define in a yaml file all the routes of our application. This facilitates our life when we need to migrate, modify, or later add new routes.

The route definition should follow the example below:

base_path: /blogroutes:
index: [/index, someClass.indexAction, GET]contact: [/contact, someClass.contactAction, GET]about: [/about, someClass.aboutAction, GET]

In our Front Controller would have something like:

<?phprequire__DIR__.'/vendor/autoload.php';
usePHPRouter\RouteCollection;
usePHPRouter\Config;
usePHPRouter\Router;
usePHPRouter\Route;
$config = Config::loadFromFile(__DIR__.'/router.yaml');
$router = Router::parseConfig($config);
$router->matchCurrentRequest();

More information

If you like PHP Router you might also like AltoRouter.

License

MIT Licensed, http://www.opensource.org/licenses/MIT