JTextWrapper
Wrapper class for JText
| since |
3.4 |
|---|---|
| deprecated |
4.0 Use |
Methods
_
Helper wrapper method for _
_(string $string, mixed $jsSafe = false, boolean $interpretBackSlashes = true, boolean $script = false) : string
| see | \JText::_ |
|---|---|
| since |
3.4 |
| deprecated |
4.0 Use |
Arguments
- $string
stringThe string to translate.- $jsSafe
mixedBoolean: Make the result javascript safe.- $interpretBackSlashes
booleanTo interpret backslashes (\=\, \n=carriage return, \t=tabulation).- $script
booleanTo indicate that the string will be push in the javascript language store.
Response
stringThe translated string or the key if $script is true.
alt
Helper wrapper method for alt
alt(string $string, string $alt, mixed $jsSafe = false, boolean $interpretBackSlashes = true, boolean $script = false) : string
| see | \JText::alt |
|---|---|
| since |
3.4 |
| deprecated |
4.0 Use |
Arguments
- $string
stringThe string to translate.- $alt
stringThe alternate option for global string.- $jsSafe
mixedBoolean: Make the result javascript safe.- $interpretBackSlashes
booleanTo interpret backslashes (\=\, \n=carriage return, \t=tabulation).- $script
booleanTo indicate that the string will be pushed in the javascript language store.
Response
stringThe translated string or the key if $script is true.
plural
Helper wrapper method for plural
plural(string $string, integer $n) : string
| see | \JText::plural |
|---|---|
| since |
3.4 |
| deprecated |
4.0 Use |
Arguments
- $string
stringThe format string.- $n
integerThe number of items.
Response
stringThe translated strings or the key if 'script' is true in the array of options.
printf
Helper wrapper method for printf
printf(string $string) : mixed
| see | \JText::printf |
|---|---|
| since |
3.4 |
| deprecated |
4.0 Use |
Arguments
- $string
stringThe format string.
Response
mixed
script
Helper wrapper method for script
script(string $string = null, boolean $jsSafe = false, boolean $interpretBackSlashes = true) : string
| see | \JText::script |
|---|---|
| since |
3.4 |
| deprecated |
4.0 Use |
Arguments
- $string
stringThe \JText key.- $jsSafe
booleanEnsure the output is JavaScript safe.- $interpretBackSlashes
booleanInterpret \t and \n.
Response
string
sprintf
Helper wrapper method for sprintf
sprintf(string $string) : string
| see | \JText::sprintf |
|---|---|
| since |
3.4 |
| deprecated |
4.0 Use |
Arguments
- $string
stringThe format string.
Response
stringThe translated strings or the key if 'script' is true in the array of options.