From b4d396d9bd1cac54fb7791c2f65f1b7f93ab11df Mon Sep 17 00:00:00 2001 From: Bernhard Posselt Date: Sat, 2 Mar 2013 21:01:39 +0100 Subject: [PATCH] update appframework docs --- developer_manual/classes/appframework/app.rst | 2 +- .../classes/appframework/http_downloadresponse.rst | 2 +- .../classes/appframework/http_redirectresponse.rst | 2 +- developer_manual/classes/appframework/http_textresponse.rst | 5 +++-- developer_manual/classes/core/view.rst | 4 ++-- 5 files changed, 8 insertions(+), 7 deletions(-) diff --git a/developer_manual/classes/appframework/app.rst b/developer_manual/classes/appframework/app.rst index ccf05faa8..d9c382acc 100644 --- a/developer_manual/classes/appframework/app.rst +++ b/developer_manual/classes/appframework/app.rst @@ -19,7 +19,7 @@ Handles all the dependency injection, controllers and output flow :param string $controllerName: the name of the controller under which it is stored in the DI container :param string $methodName: the method that you want to call :param array $urlParams: an array with variables extracted from the routes - :param \\Pimple $container: an instance of a pimple container. if not passed, a new one will be instantiated. This can be used to swap or overwrite objects in the container. + :param \\Pimple $container: an instance of a pimple container. Shortcut for calling a controller method and printing the result diff --git a/developer_manual/classes/appframework/http_downloadresponse.rst b/developer_manual/classes/appframework/http_downloadresponse.rst index e2c3a6d14..9616fc9d4 100644 --- a/developer_manual/classes/appframework/http_downloadresponse.rst +++ b/developer_manual/classes/appframework/http_downloadresponse.rst @@ -2,7 +2,7 @@ DownloadResponse ================ -Prompts the user to download the a textfile +Prompts the user to download the a file .. php:namespace:: OCA\AppFramework\Http diff --git a/developer_manual/classes/appframework/http_redirectresponse.rst b/developer_manual/classes/appframework/http_redirectresponse.rst index ba1cd07f9..0e321d1d3 100644 --- a/developer_manual/classes/appframework/http_redirectresponse.rst +++ b/developer_manual/classes/appframework/http_redirectresponse.rst @@ -2,7 +2,7 @@ RedirectResponse ================ -Prompts the user to download the a textfile +Redirects to a different URL .. php:namespace:: OCA\AppFramework\Http diff --git a/developer_manual/classes/appframework/http_textresponse.rst b/developer_manual/classes/appframework/http_textresponse.rst index 893a68702..42e670bd5 100644 --- a/developer_manual/classes/appframework/http_textresponse.rst +++ b/developer_manual/classes/appframework/http_textresponse.rst @@ -2,7 +2,7 @@ TextResponse ============ -Prompts the user to download the a textfile +Just outputs text to the browser .. php:namespace:: OCA\AppFramework\Http @@ -11,9 +11,10 @@ Prompts the user to download the a textfile - .. php:method:: __construct($content) + .. php:method:: __construct($content, $contentType='plain') :param string $content: the content that should be written into the file + :param string $contentType: the mimetype. text/ is added automatically soonly plain or html can be added to get text/plain or text/html Creates a response that just outputs text diff --git a/developer_manual/classes/core/view.rst b/developer_manual/classes/core/view.rst index 966bc5189..2d623245d 100644 --- a/developer_manual/classes/core/view.rst +++ b/developer_manual/classes/core/view.rst @@ -55,7 +55,7 @@ View :returns string: - get the mountpoint of the storage object for a path( note: because a storage is not always mounted inside the fakeroot, the returned mountpoint is relative to the absolute root of the filesystem and doesn't take the chroot into account + get the mountpoint of the storage object for a path( note: because a storage is not always mounted inside the fakeroot, thereturned mountpoint is relative to the absolute root of the filesystemand doesn't take the chroot into account ) .. php:method:: resolvePath($path) @@ -73,7 +73,7 @@ View :returns string: - return the path to a local version of the filewe need this because we can't know if a file is stored local or not from outside the filestorage and for some purposes a local file is needed + return the path to a local version of the filewe need this because we can't know if a file is stored local or not fromoutside the filestorage and for some purposes a local file is needed .. php:method:: getLocalFolder($path)