README.md

   1 # PHP Router class
   2
   3 A simple Rails inspired PHP router class.
   4
   5 * Usage of different HTTP Methods
   6 * REST / Resourceful routing
   7 * Reversed routing using named routes
   8 * Dynamic URL's: use URL segments as parameters.
   9
  10 ## Usage
  11
  12     <?php
  13     require 'Router.php';
  14     require 'Route.php';
  15
  16     $router = new Router();
  17
  18     $router->setBasePath('/rest-router');
  19
  20     // maps / to controller 'users' and method 'index'.
  21     $router->map('/', 'users#index', array('methods' => 'GET'));
  22     $router->map('/users/:id/edit/', 'users#edit', array('methods' => 'GET', 'name' => 'user_edit_page'));
  23
  24     $params = $router->matchCurrentRequest();
  25     var_dump($params);
  26
  27 ?><h3>Reversed routing</h3><?php
  28 // echoes /users/5/edit
  29 echo "Route for user_edit_page with ID 5: ". $router->reverse('user_edit_page', array('id' => '5'));
  30
  31
  32 ## More information
  33 Have a look at the example file or read trough the class' documentation for a better understanding on how to use this class.