more api docs on the main page

This commit is contained in:
Bernhard Posselt
2013-01-26 17:28:39 +01:00
parent 4609ff0397
commit 0e104febc9
3 changed files with 24 additions and 19 deletions

View File

@@ -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.

View File

@@ -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 <http://www.martinfowler.com/eaaCatalog/dataMapper.html>`_. 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 <http://www.martinfowler.com/eaaCatalog/dataMapper.html>`_. The mapper class could look like this (more method examples are in the **advancedapptemplate** app):
:file:`db/itemmapper.php`

View File

@@ -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 <http://angularjs.org/>`_
* :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
================