From 4d8dedb9f5b0a0d6bc4429a77c93acca40cabe31 Mon Sep 17 00:00:00 2001
From: Danny van Kooten <dannyvankooten@gmail.com>
Date: Wed, 1 Aug 2012 11:05:42 +0200
Subject: [PATCH] Updated readme, added more inline documentation.

---
 AltoRouter.php | 22 +++++++++++++++++++++-
 README.md      |  6 +++---
 2 files changed, 24 insertions(+), 4 deletions(-)

diff --git a/AltoRouter.php b/AltoRouter.php
index dccc97c..09bf999 100644
--- a/AltoRouter.php
+++ b/AltoRouter.php
@@ -1,15 +1,26 @@
 <?php
 
 class AltoRouter {
+
 	private $routes = array();
 	private $namedRoutes = array();
 	private $basePath = '';
 
+	/**
+	* Set the base path.
+	* Useful if you are running your application from a subdirectory.
+	*/
 	public function setBasePath($basePath) {
 		$this->basePath = $basePath;
 	}
 	/**
 	* Map a route to a target
+	*
+	* @param string $method One of 4 HTTP Methods, or a pipe-separated list of multiple HTTP Methods (GET|POST|PUT|DELETE)
+	* @param string $route The route regex, custom regex must start with an @. You can use multiple pre-set regex filters, like [i:id]
+	* @param mixed $target The target where this route should point to. Can be anything.
+	* @param string $name Optional name of this route. Supply if you want to reverse route this url in your application.
+	*
 	*/
 	public function map($method, $route, $target, $name = null) {
 		
@@ -25,12 +36,18 @@ class AltoRouter {
 			}
 			
 		}
+
+		return;
 	}
 
 	/**
 	* Reversed routing
 	*
 	* Generate the URL for a named route. Replace regexes with supplied parameters
+	*
+	* @param string $routeName The name of the route.
+	* @param array @params Associative array of parameters to replace placeholders with.
+	* @return string The URL of the route with named parameters in place.
 	*/
 	public function generate($routeName, array $params = array()) {
 
@@ -61,6 +78,9 @@ class AltoRouter {
 
 	/**
 	* Match a given Request Url against stored routes
+	* @param string $requestUrl
+	* @param string $requestMethod
+	* @return array|boolean Array with route information on success, false on failure (no match).
 	*/
 	public function match($requestUrl = null, $requestMethod = null) {
 
@@ -141,7 +161,7 @@ class AltoRouter {
       		
 
       		if(($match == true || $match > 0)) {
-      			
+
       			if($params) {
       				foreach($params as $key => $value) {
       					if(is_numeric($key)) unset($params[$key]);
diff --git a/README.md b/README.md
index 7a9d487..acd45bf 100644
--- a/README.md
+++ b/README.md
@@ -18,10 +18,10 @@ $router = new AltoRouter();
 $router->setBasePath('/AltoRouter');
 
 // mapping routes
-$router->map('GET|POST','/', 'home#index', array('name' => 'home'));
+$router->map('GET|POST','/', 'home#index', 'home');
 $router->map('GET','/users/', array('c' => 'UserController', 'a' => 'ListAction'));
-$router->map('GET','/users/[i:id]', 'users#show', array('name' => 'users_show'));
-$router->map('POST','/users/[i:id]/[delete|update:action]', 'usersController#doAction', array('name' => 'users_do'));
+$router->map('GET','/users/[i:id]', 'users#show', 'users_show');
+$router->map('POST','/users/[i:id]/[delete|update:action]', 'usersController#doAction', 'users_do');
 
 
 // reversed routing