From daa58af21658543b2140305f883f321462d1e72b Mon Sep 17 00:00:00 2001 From: Danny van Kooten Date: Thu, 9 Feb 2012 21:13:00 +0100 Subject: [PATCH] Updated readme for 1.1 --- README.md | 22 ++++++++++++---------- example.php | 5 ++--- 2 files changed, 14 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index f8594d0..c453bec 100644 --- a/README.md +++ b/README.md @@ -15,19 +15,21 @@ A simple Rails inspired PHP router class. $router = new Router(); - $router->setBasePath('/rest-router'); + $router->setBasePath('/PHP-Router'); - // maps / to controller 'users' and method 'index'. - $router->map('/', 'users#index', array('methods' => 'GET')); - $router->map('/users/:id/edit/', 'users#edit', array('methods' => 'GET', 'name' => 'user_edit_page')); + // defining routes can be as simple as this + $router->map('/', 'users#index'); - $params = $router->matchCurrentRequest(); - var_dump($params); + // or somewhat more complicated + $router->map('/users/:id/edit/', array('controller' => 'SomeController', 'action' => 'someAction'), array('methods' => 'GET,PUT', 'name' => 'users_edit')); - ?>

Reversed routing

reverse('user_edit_page', array('id' => '5')); + // match current request URL & http method + $target = $router->matchCurrentRequest(); + var_dump($target); + + // generate an URL + $router->generate('users_edit', array('id' => 5)); ## More information -Have a look at the example file or read trough the class' documentation for a better understanding on how to use this class. \ No newline at end of file +Have a look at the example.php file or read trough the class' documentation for a better understanding on how to use this class. \ No newline at end of file diff --git a/example.php b/example.php index 2b2572d..011701b 100644 --- a/example.php +++ b/example.php @@ -9,14 +9,13 @@ $router->setBasePath('/PHP-Router'); $router->map('/', 'someController:indexAction', array('methods' => 'GET')); $router->map('/users/:id/edit/', 'users#edit', array('methods' => 'GET', 'name' => 'users_edit')); $router->map('/contact/',array('controller' => 'someController', 'action' => 'contactAction'), array('name' => 'contact')); -$router-> map('/users/','users#create', array('methods' => 'POST', 'name' => 'users_create')); -$router-> map('/users/','users#list', array('methods' => 'GET', 'name' => 'users_list')); +$router->map('/users/','users#create', array('methods' => 'POST', 'name' => 'users_create')); +$router->map('/users/','users#list', array('methods' => 'GET', 'name' => 'users_list')); ?>

Current URL & HTTP method would route to:

matchCurrentRequest()); ?>

Try out these URL's.

-

generate('users_edit', array('id' => 5)); ?>

generate('contact'); ?>

-- 2.11.0