From ae2b9e1cc2712b74746e95e56309d2da5fd4a85a Mon Sep 17 00:00:00 2001 From: Bernhard Posselt Date: Tue, 29 Jan 2013 23:14:07 +0100 Subject: [PATCH] added docs for abs_url --- developer_manual/app/templates.rst | 14 ++++++++++++++ developer_manual/classes/appframework/core_api.rst | 9 +++++++++ .../db_multipleobjectsreturnedexception.rst | 3 ++- 3 files changed, 25 insertions(+), 1 deletion(-) diff --git a/developer_manual/app/templates.rst b/developer_manual/app/templates.rst index d2bbe0c20..99b766505 100644 --- a/developer_manual/app/templates.rst +++ b/developer_manual/app/templates.rst @@ -88,6 +88,20 @@ The App Framework comes with additional template functions for Twig to better in {{ url('apptemplate_advanced_params', {value: 'hi'}) }} +.. js:function:: abs_url(route, params=null) + + :param string route: the name of the route + :param string params: the params written like a JavaScript object + + Same as :js:func:`url` but prints an absolute URL + + An example would be: + + .. code-block:: js + + {{ abs_url('apptemplate_advanced_params', {value: 'hi'}) }} + + .. js:function:: t(toTranslate, params=null) :param string toTranslate: the string which should be translated diff --git a/developer_manual/classes/appframework/core_api.rst b/developer_manual/classes/appframework/core_api.rst index fb01a0dd3..41404eb22 100644 --- a/developer_manual/classes/appframework/core_api.rst +++ b/developer_manual/classes/appframework/core_api.rst @@ -151,6 +151,15 @@ class and add your methods Returns the URL for a route + .. php:method:: getAbsoluteURL($url) + + :param string $url: the url + :returns string: the absolute url + + + Makes an URL absolute + + .. php:method:: linkToAbsolute($file, $appName=null) :param string $file: the name of the file diff --git a/developer_manual/classes/appframework/db_multipleobjectsreturnedexception.rst b/developer_manual/classes/appframework/db_multipleobjectsreturnedexception.rst index 6b2907c8c..ef67d8a2a 100644 --- a/developer_manual/classes/appframework/db_multipleobjectsreturnedexception.rst +++ b/developer_manual/classes/appframework/db_multipleobjectsreturnedexception.rst @@ -14,4 +14,5 @@ row .. php:method:: __construct($msg) - :param mixed $msg: + :param mixed $msg: +