Text
Text handling class.
| since |
1.7.0 |
|---|
Methods
_
Translates a string into the current language.
_(string $string, mixed $jsSafe = false, boolean $interpretBackSlashes = true, boolean $script = false) : string
Examples:
<script>alert(Joomla.JText._('<?php echo Text::_("JDEFAULT", array("script"=>true)); ?>'));</script>
will generate an alert message containing 'Default'
<?php echo Text::_("JDEFAULT"); ?> will generate a 'Default' string
| since |
1.7.0 |
|---|
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
Translates a string into the current language.
alt(string $string, string $alt, mixed $jsSafe = false, boolean $interpretBackSlashes = true, boolean $script = false) : string
Examples:
<?php echo Text::alt('JALL', 'language'); ?> will generate a 'All' string in English but a "Toutes" string in French
<?php echo Text::alt('JALL', 'module'); ?> will generate a 'All' string in English but a "Tous" string in French
| since |
1.7.0 |
|---|
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
getScriptStrings
Get the strings that have been loaded to the JavaScript language store.
getScriptStrings() : array
| since |
3.7.0 |
|---|
Response
array
passSprintf
Checks the string if it should be interpreted as sprintf and runs sprintf over it.
passSprintf( &$string, mixed $jsSafe = false, boolean $interpretBackSlashes = true, boolean $script = false) : boolean
| since |
3.4.4 |
|---|
Arguments
- $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 push in the javascript language store
Response
booleanWhether the string be interpreted as sprintf
plural
Like Text::sprintf but tries to pluralise the string.
plural(string $string, integer $n) : string
Note that this method can take a mixed number of arguments as for the sprintf function.
The last argument can take an array of options:
array('jsSafe'=>boolean, 'interpretBackSlashes'=>boolean, 'script'=>boolean)
where:
jsSafe is a boolean to generate a javascript safe strings. interpretBackSlashes is a boolean to interpret backslashes \->\, \n->new line, \t->tabulation. script is a boolean to indicate that the string will be push in the javascript language store.
Examples:
<script>alert(Joomla.JText._('<?php echo Text::plural("COM_PLUGINS_N_ITEMS_UNPUBLISHED", 1, array("script"=>true)); ?>'));</script>
will generate an alert message containing '1 plugin successfully disabled'
<?php echo Text::plural('COM_PLUGINS_N_ITEMS_UNPUBLISHED', 1); ?> will generate a '1 plugin successfully disabled' string
| since |
1.7.0 |
|---|
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
Passes a string thru an printf.
printf(string $string) : mixed
Note that this method can take a mixed number of arguments as for the sprintf function.
| since |
1.7.0 |
|---|
Arguments
- $string
stringThe format string.
Response
mixed
script
Translate a string into the current language and stores it in the JavaScript language store.
script(string $string = null, boolean $jsSafe = false, boolean $interpretBackSlashes = true) : string
| since |
1.7.0 |
|---|
Arguments
- $string
stringThe Text key.- $jsSafe
booleanEnsure the output is JavaScript safe.- $interpretBackSlashes
booleanInterpret \t and \n.
Response
string
sprintf
Passes a string thru a sprintf.
sprintf(string $string) : string
Note that this method can take a mixed number of arguments as for the sprintf function.
The last argument can take an array of options:
array('jsSafe'=>boolean, 'interpretBackSlashes'=>boolean, 'script'=>boolean)
where:
jsSafe is a boolean to generate a javascript safe strings. interpretBackSlashes is a boolean to interpret backslashes \->\, \n->new line, \t->tabulation. script is a boolean to indicate that the string will be push in the javascript language store.
| since |
1.7.0 |
|---|
Arguments
- $string
stringThe format string.
Response
stringThe translated strings or the key if 'script' is true in the array of options.
Properties
strings
JavaScript strings
| since |
1.7.0 |
|---|
Type(s)
array