View source for Theme editor - Available Twig functions

== PHP included functions ==

* [http://php.net/array-flip array_flip]
* [http://php.net/array_intersect_key array_intersect_key]
* [http://php.net/str_replace str_replace]
* [http://php.net/intval intval]
* [http://php.net/empty empty]
* [http://php.net/reset reset]
* [http://php.net/in_array in_array]
* [http://php.net/array_search array_search]
* [http://php.net/isset isset]
* [http://php.net/sprintf sprintf]

== Specific function for LimeSurvey ==

=== Text update and management ===

==== flatString ====
Get html text and remove whole not clean string.
Parameters are
* the string to flatten
* a boolean encode html entities (default to false)

==== ellipsizeString ====
Get a flat and ellipsize string.
Parameters are
* the string to ellipsize
* an integer max length of the final string
* a float $position of the ellipsis in string (between 0 and 1), default to 1 mean the string is ellipsize at end.
* a string ellipsis string to shown in place of removed part, default to …

==== processString ====

Process ExpressionScript with any string with current page information, return a string. 
Parameters are
* the string to be processed
* a boolean : return static string (or not), default to no.
* an integer : recursion (max) level to do, default to 3
* an array of string: replacement out of current expression know vars. The key is the value to be replaced, the value is the replacement.

=== Image and file source ===

==== image ====

Create a image tag, parameters are

* The source of image, realted to theme directory (./img/logo.png for example)
* alt attribute 
* array of extra html function (as array for twig : <code>{"class": "logo img-fluid"}</code>)

==== imageSrc ====

Create the dynamic source to an image inside theme, using parent theme if image are not found in current one. Retuen an image only.

* Image path relative to theme directory
* default value if not found

==== templateResourceUrl ====

Create the dynamic source of a file, using parent theme if file are not found in current one.

* file path relative to theme directory
* default value if not found

=== Language management ===

==== gT ====

==== ngT ====

=== Get information ===

==== getConfig ====
Get the current config part for this instance of LimeSurvey for the parameter. Return the existing config, false if not set.

=== getPost ===
Get the current $_POST value for the parameter. Return the existing $_POST, null if not set.

==== getQuery ====
Get the current $_GET value for the parameter. Return the existing $_GET, null if not set.

==== getParam ====
Get the current $_PARAM value for the parameter. Returns the existing $_PARAM, null if not set.

=== Script and css management ===

* registerPublicCssFile
* registerTemplateCssFile
* registerGeneralScript
* registerTemplateScript
* registerScript
* registerPackage
* unregisterPackage
* registerCssFile
* registerScriptFile
* unregisterScriptFile
* unregisterScriptForAjax
* listCoreScripts
* listScriptFiles

=== Others ===

==== getAllTokenAnswers ====

== Adding a function ==

=== By updating config.php ===
You can add any PHP existing function easily in your config.php file. This is done by adding the function in twigRenderer.

<syntaxhighlight lang="php" enclose="pre">
		'twigRenderer' => array(
			'functions' => array(
				'strlen' => 'strlen',
			),
			'sandboxConfig' => array(
				'functions' => array(
					'strlen',
				),
			),
		),
</syntaxhighlight>

=== By extension ===

See [https://github.com/LimeSurvey/LimeSurvey/tree/master/upload/twig/extensions Custom Twig Extension for LimeSurvey]

[[Category:Theme]]
[[Category:Twig]]
[[Category:Development]]