From a2467f5ed31250696476a71df58f9743e9fd002f Mon Sep 17 00:00:00 2001 From: Bernhard Posselt Date: Tue, 29 Jan 2013 22:27:57 +0100 Subject: [PATCH] updated appframework api --- .../appframework/controller_controller.rst | 8 ++++++++ .../db_multipleobjectsreturnedexception.rst | 17 +++++++++++++++++ .../classes/appframework/http_request.rst | 8 ++++++++ developer_manual/classes/appframework/index.rst | 1 + 4 files changed, 34 insertions(+) create mode 100644 developer_manual/classes/appframework/db_multipleobjectsreturnedexception.rst diff --git a/developer_manual/classes/appframework/controller_controller.rst b/developer_manual/classes/appframework/controller_controller.rst index 4061c70e7..783bf7650 100644 --- a/developer_manual/classes/appframework/controller_controller.rst +++ b/developer_manual/classes/appframework/controller_controller.rst @@ -44,6 +44,14 @@ Baseclass to inherit your controllers from Lets you access post and get parameters by the index + .. php:method:: getParams() + + :returns array: the array with all parameters + + + Returns all params that were received, be it from the request(as GET or POST) or throuh the URL by the route + + .. php:method:: getUploadedFile($key) :param string $key: the key that will be taken from the $_FILES array diff --git a/developer_manual/classes/appframework/db_multipleobjectsreturnedexception.rst b/developer_manual/classes/appframework/db_multipleobjectsreturnedexception.rst new file mode 100644 index 000000000..6b2907c8c --- /dev/null +++ b/developer_manual/classes/appframework/db_multipleobjectsreturnedexception.rst @@ -0,0 +1,17 @@ +MultipleObjectsReturnedException +================================ + + +This is returned or should be returned when a find request finds more than one +row + + +.. php:namespace:: OCA\AppFramework\Db +.. php:class:: MultipleObjectsReturnedException + + + + + .. php:method:: __construct($msg) + + :param mixed $msg: diff --git a/developer_manual/classes/appframework/http_request.rst b/developer_manual/classes/appframework/http_request.rst index ab7bc6655..110756a6a 100644 --- a/developer_manual/classes/appframework/http_request.rst +++ b/developer_manual/classes/appframework/http_request.rst @@ -19,6 +19,14 @@ Encapsulates $_GET, $_FILES and $_POST arrays for better testability + .. php:method:: getGETAndPOST() + + :returns array: the merged array + + + Returns the merged GET and POST array + + .. php:method:: getGET($key, $default=null) :param string $key: the array key that should be looked up diff --git a/developer_manual/classes/appframework/index.rst b/developer_manual/classes/appframework/index.rst index c798aeeb3..af5b0fbd5 100644 --- a/developer_manual/classes/appframework/index.rst +++ b/developer_manual/classes/appframework/index.rst @@ -9,6 +9,7 @@ AppFramework API controller_controller core_api db_doesnotexistexception + db_multipleobjectsreturnedexception db_mapper dependencyinjection_dicontainer http_response