Class JText

Text handling class.

Package: Joomla\Platform\Language
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 11.1
Located at joomla/language/text.php

Methods summary

`public static string`	# `_( string $string, mixed $jsSafe = false, boolean $interpretBackSlashes = true, boolean $script = false )` Translates a string into the current language. Translates a string into the current language. Examples: `<script>alert(Joomla.JText._('<?php echo JText::_("JDEFAULT", array("script"=>true)); ?>'));</script>` will generate an alert message containing 'Default' `<?php echo JText::_("JDEFAULT"); ?>` will generate a 'Default' string Parameters `$string` `string` - $string The string to translate. `$jsSafe` `mixed` - $jsSafe Boolean: Make the result javascript safe. `$interpretBackSlashes` `boolean` - $interpretBackSlashes To interpret backslashes (\\=\, \n=carriage return, \t=tabulation) `$script` `boolean` - $script To indicate that the string will be push in the javascript language store Returns `string` - The translated string or the key if $script is true Since 11.1
`public static string`	# `alt( string $string, string $alt, mixed $jsSafe = false, boolean $interpretBackSlashes = true, boolean $script = false )` Translates a string into the current language. Translates a string into the current language. Examples: `<?php echo JText::alt('JALL', 'language'); ?>` will generate a 'All' string in English but a "Toutes" string in French `<?php echo JText::alt('JALL', 'module'); ?>` will generate a 'All' string in English but a "Tous" string in French Parameters `$string` `string` - $string The string to translate. `$alt` `string` - $alt The alternate option for global string `$jsSafe` `mixed` - $jsSafe Boolean: Make the result javascript safe. `$interpretBackSlashes` `boolean` - $interpretBackSlashes To interpret backslashes (\\=\, \n=carriage return, \t=tabulation) `$script` `boolean` - $script To indicate that the string will be pushed in the javascript language store Returns `string` - The translated string or the key if $script is true Since 11.1
`public static string`	# `plural( string $string, integer $n )` Like JText::sprintf but tries to pluralise the string. Like JText::sprintf but tries to pluralise the 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 JText::plural("COM_PLUGINS_N_ITEMS_UNPUBLISHED", 1, array("script"=>true)); ?>'));</script>` will generate an alert message containing '1 plugin successfully disabled' `<?php echo JText::plural('COM_PLUGINS_N_ITEMS_UNPUBLISHED', 1); ?>` will generate a '1 plugin successfully disabled' string Parameters `$string` `string` - $string The format string. `$n` `integer` - $n The number of items Returns `string` - The translated strings or the key if 'script' is true in the array of options Since 11.1
`public static string`	# `sprintf( string $string )` Passes a string thru a sprintf. Passes a string thru a sprintf. 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. Parameters `$string` `string` - $string The format string. Returns `string` - The translated strings or the key if 'script' is true in the array of options. Since 11.1
`public static mixed`	# `printf( format $string )` Passes a string thru an printf. Passes a string thru an printf. Note that this method can take a mixed number of arguments as for the sprintf function. Parameters `$string` `format` - $string The format string. Returns `mixed` Since 11.1
`public static string`	# `script( string $string = null, boolean $jsSafe = false, boolean $interpretBackSlashes = true )` Translate a string into the current language and stores it in the JavaScript language store. Translate a string into the current language and stores it in the JavaScript language store. Parameters `$string` `string` - $string The JText key. `$jsSafe` `boolean` - $jsSafe Ensure the output is JavaScript safe. `$interpretBackSlashes` `boolean` - $interpretBackSlashes Interpret \t and \n. Returns `string` Since 11.1
`public static array`	# `getScriptStrings( )` Get the strings that have been loaded to the JavaScript language store. Get the strings that have been loaded to the JavaScript language store. Returns `array` Since 3.7.0

Magic methods summary

Properties summary

`protected static array`	`$strings`	# JavaScript strings JavaScript strings Since 11.1

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JText

Methods summary

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Returns

Since

Magic methods summary

Properties summary

Since