From 91eb7f437533f9ec589dd6a0f0b039560bcac151 Mon Sep 17 00:00:00 2001 From: Bernhard Posselt Date: Mon, 29 Oct 2012 17:46:45 +0100 Subject: [PATCH] ordered functions and methods alphabetically --- developer_manual/templates.rst | 279 +++++++++++++++++---------------- 1 file changed, 140 insertions(+), 139 deletions(-) diff --git a/developer_manual/templates.rst b/developer_manual/templates.rst index a09057c66..cd49302c5 100644 --- a/developer_manual/templates.rst +++ b/developer_manual/templates.rst @@ -18,13 +18,23 @@ Template class :returns: OC_Template object - .. php:method:: detectFormfactor() + .. php:method:: addHeader($tag, $attributes[, $text='']) - :returns: The mode of the client as a string. **default** -> the normal desktop browser interface, **mobile** -> interface for smartphones, **tablet** -> interface for tablets, **standalone** -> the default interface but without header, footer and sidebar, just the application. Useful to use just a specific app on the desktop in a standalone window. + :param string $tag: tag name of the element + :param array $attributes: array of attrobutes for the element + :param string $text: the text content for the element + + Add a custom element to the html + + + .. php:method:: append($key, $value) + + :param string $key: the key under which the variable can be accessed in the template + :param $value: the value that we want to pass + :returns: bool + + This function assigns a variable in an array context. If the key already exists, the value will be appended. It can be accessed via $_[$key][$position] in the template. - .. php:method:: getFormFactorExtension() - - :returns: Returns the formfactor extension for current formfactor (like .mobile or .tablet) .. php:method:: assign($key, $value[, $sanitizeHTML=true]) @@ -36,32 +46,10 @@ Template class This function assigns a variable. It can be accessed via $_[$key] in the template. If the key existed before, it will be overwritten - .. php:method:: getFormFactorExtension() - - :returns: Returns the formfactor extension for current formfactor (like .mobile or .tablet) + .. php:method:: detectFormfactor() - .. php:method:: append($key, $value) + :returns: The mode of the client as a string. **default** -> the normal desktop browser interface, **mobile** -> interface for smartphones, **tablet** -> interface for tablets, **standalone** -> the default interface but without header, footer and sidebar, just the application. Useful to use just a specific app on the desktop in a standalone window. - :param string $key: the key under which the variable can be accessed in the template - :param $value: the value that we want to pass - :returns: bool - - This function assigns a variable in an array context. If the key already exists, the value will be appended. It can be accessed via $_[$key][$position] in the template. - - .. php:method:: addHeader($tag, $attributes[, $text='']) - - :param string $tag: tag name of the element - :param array $attributes: array of attrobutes for the element - :param string $text: the text content for the element - - Add a custom element to the html - - - .. php:method:: printPage() - - :returns: true when there is content to print - - This function proceeds the template and prints its output. .. php:method:: fetchPage() @@ -71,6 +59,11 @@ Template class This function proceeds the template and but prints no output. + .. php:method:: getFormFactorExtension() + + :returns: Returns the formfactor extension for current formfactor (like .mobile or .tablet) + + .. php:method:: inc($file[, $additionalparams]) :param string $file: the name of the template @@ -80,14 +73,11 @@ Template class Includes another template. use inc('template'); ?> to do this. - .. php:method:: printUserPage($application, $name[, $parameters]) + .. php:method:: printPage() - :param string $application: The application we render the template for - :param string $name: Name of the template - :param array $parameters: Parameters for the template - :returns: bool + :returns: true when there is content to print - Shortcut to print a simple page for users + This function proceeds the template and prints its output. .. php:method:: printAdminPage($application, $name[, $parameters]) @@ -110,8 +100,112 @@ Template class Shortcut to print a simple page for guests + .. php:method:: printUserPage($application, $name[, $parameters]) + + :param string $application: The application we render the template for + :param string $name: Name of the template + :param array $parameters: Parameters for the template + :returns: bool + + Shortcut to print a simple page for users + + Template syntax --------------- +.. php:function:: html_select_options($options, $selected[, $params]) + + :param array $options: an array of the form value => label + :param string/array $selected: an array containing strings or a simple string which sets a value as selected + :param array $params: optional parameters that are done in key => value + :returns: the html as string of preset