From 0e104febc9be9c80f6baa86ee107663c813b7467 Mon Sep 17 00:00:00 2001 From: Bernhard Posselt Date: Sat, 26 Jan 2013 17:28:39 +0100 Subject: [PATCH] more api docs on the main page --- developer_manual/app/controllers.rst | 2 +- developer_manual/app/database.rst | 2 +- developer_manual/index.rst | 39 ++++++++++++++++------------ 3 files changed, 24 insertions(+), 19 deletions(-) diff --git a/developer_manual/app/controllers.rst b/developer_manual/app/controllers.rst index b8ccbb263..024c635a5 100644 --- a/developer_manual/app/controllers.rst +++ b/developer_manual/app/controllers.rst @@ -57,7 +57,7 @@ The apptemplate comes with several different controllers. A simple controller wo ?> -An instance of the API is passed via dependency injection, the same goes for a Request instance. URL Parameters, POST, GET and FILES parameters are partly abstracted by the Request class and can be accessed via **$this->params('myURLParamOrPostOrGetKey')** and **$this->getUploadedFile($key)** inside the controller. This has been done to make the app better testable. +An instance of the API is passed via dependency injection, the same goes for a :php:class:`OCA\\AppFramework\\Http\\Request` instance. URL Parameters, POST, GET and FILES parameters are partly abstracted by the Request class and can be accessed via **$this->params('myURLParamOrPostOrGetKey')** and **$this->getUploadedFile($key)** inside the controller. This has been done to make the app better testable. .. note:: If an URL Parameter, POST or GET value exist with the same key, the URL Parameter is preferred over the POST parameter and the POST parameter is preferred over the GET parameter. You should avoid this scenario though. diff --git a/developer_manual/app/database.rst b/developer_manual/app/database.rst index a07640bd8..48053b33d 100644 --- a/developer_manual/app/database.rst +++ b/developer_manual/app/database.rst @@ -122,7 +122,7 @@ Your database layer should go into the **db/** folder. It's recommended to split } -All database queries for that object should be put into a mapper class. This follows the `data mapper pattern `_. The mapper class could look like this (more method examples are in the advanced_apptemplate): +All database queries for that object should be put into a mapper class. This follows the `data mapper pattern `_. The mapper class could look like this (more method examples are in the **advancedapptemplate** app): :file:`db/itemmapper.php` diff --git a/developer_manual/index.rst b/developer_manual/index.rst index 95ba0545f..aa6c3ec35 100644 --- a/developer_manual/index.rst +++ b/developer_manual/index.rst @@ -32,51 +32,52 @@ General * :doc:`general/codereviews` * :doc:`general/debugging` * :doc:`general/kanban` -* :doc:`general/angular` -* :doc:`general/dependencyinjection` +* :doc:`general/angular` | `AngularJS Documentation `_ +* :doc:`general/dependencyinjection` | `Pimple`_ Apps Developement ================= * :doc:`app/gettingstarted` -* :doc:`app/settings` -* `Pimple`_ +* :doc:`app/settings` | `Pimple`_ * :doc:`app/classloader` -* :doc:`app/api` +* :doc:`app/api` | :php:class:`OCA\\AppFramework\\Core\\API` Routing ------- -* :doc:`app/routes` -* `Symfony Routing`_ +* :doc:`app/routes` | `Symfony Routing`_ +* :php:class:`OCA\\AppFramework\\App` Controllers ----------- -* :doc:`app/controllers` +* :doc:`app/controllers` | :php:class:`OCA\\AppFramework\\Controller\\Controller` Database Access --------------- -* :doc:`app/database` +* :doc:`app/database` | :php:class:`OCA\\AppFramework\\Db\\Mapper` * :doc:`app/data-migration` Templates --------- -* :doc:`app/templates` -* `Twig Templates`_ +* :doc:`app/templates` | `Twig Templates`_ | :php:class:`OC_Template` +* :php:class:`OCA\\AppFramework\\Http\\TemplateResponse` + JavaScript & CSS ---------------- - * :doc:`app/static` Testing ------- -* :doc:`app/unittesting` -* `PHPUnit`_ +* :doc:`app/unittesting` | `PHPUnit`_ +* :php:class:`OCA\\AppFramework\\Utility\\ControllerTestUtility` -Middlware ---------- -* :doc:`app/middleware` +Middleware +---------- +* :doc:`app/middleware` | :php:class:`OCA\\AppFramework\\Middleware\\Middleware` +* :php:class:`OCA\\AppFramework\\Middleware\\Security\\SecurityMiddleware` +* :php:class:`OCA\\AppFramework\\Middleware\\Twig\\TwigMiddleware` ownCloud APIs ============= @@ -96,6 +97,10 @@ Core * :doc:`core/theming` * :doc:`core/configfile` +Sourcecode Documentation +======================== +* :doc:`classes/appframework/index` +* :doc:`classes/core/index` Index and Tables ================