From 1fdd2ac7eed9cfd0322e6f17957a083310311470 Mon Sep 17 00:00:00 2001 From: Thomas Müller Date: Mon, 25 Nov 2013 17:15:08 +0100 Subject: adding documentation for registerRoutes() --- lib/public/appframework/app.php | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/lib/public/appframework/app.php b/lib/public/appframework/app.php index 1f82f8da889..1021a21397f 100644 --- a/lib/public/appframework/app.php +++ b/lib/public/appframework/app.php @@ -49,7 +49,19 @@ class App { } /** - * This function is to be called + * This function is to be called to create single routes and restful routes based on the given $routes array. + * + * Example code in routes.php of tasks app (it will register two restful resources): + * $routes = array( + * 'resources' => array( + * 'lists' => array('url' => '/tasklists'), + * 'tasks' => array('url' => '/tasklists/{listId}/tasks') + * ) + * ); + * + * $a = new TasksApp(); + * $a->registerRoutes($this, $routes); + * * @param \OC_Router $router * @param array $routes */ -- cgit v1.2.3