Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
core\output\mustache_clean_string_helper Class Reference

This class will load language strings in a template. More...

Public Member Functions

 __construct ()
 Create new instance of mustache clean string helper.
 
 cleanstr ($text, Mustache_LambdaHelper $helper)
 Read a lang string from a template and get it from get_string.
 

Detailed Description

This class will load language strings in a template.

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
Since
4.0

Member Function Documentation

◆ cleanstr()

core\output\mustache_clean_string_helper::cleanstr ( $text,
Mustache_LambdaHelper $helper )

Read a lang string from a template and get it from get_string.

Some examples for calling this from a template are:

{{#cleanstr}}activity{{/cleanstr}} {{#cleanstr}}actionchoice, core, {{#str}}delete{{/str}}{{/cleanstr}} (Together with the str helper) {{#cleanstr}}uploadrenamedchars, core, {"oldname":"Old", "newname":"New"}{{/cleanstr}} (Complex $a)

The args are comma separated and only the first is required. The last is a $a argument for get string. For complex data here, use JSON.

Parameters
string$textThe text to parse for arguments.
Mustache_LambdaHelper$helperUsed to render nested mustache variables.
Return values
string

The documentation for this class was generated from the following file: