update appframework docs

This commit is contained in:
Bernhard Posselt
2013-03-02 21:01:39 +01:00
parent fe6a57dafb
commit b4d396d9bd
5 changed files with 8 additions and 7 deletions

View File

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

View File

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

View File

@@ -2,7 +2,7 @@ RedirectResponse
================
Prompts the user to download the a textfile
Redirects to a different URL
.. php:namespace:: OCA\AppFramework\Http

View File

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

View File

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