Language
Languages/translation handler class
| since |
1.7.0 |
|---|---|
| package |
Joomla CMS |
Methods
_
Translate function, mimics the php gettext (alias _) function.
_( string, jsSafe = false, interpretBackSlashes = true) :
The function checks if $jsSafe is true, then if $interpretBackslashes is true.
| since |
1.7.0 |
|---|
Arguments
- string
stringThe string to translate- jsSafe
boolParameter to add slashes to the string that will be rendered as JavaScript. However, set as "false" if the string is going to be encoded by json_encode().- interpretBackSlashes
boolInterpret \t and \n
Response
stringThe translation of the string
__construct
Constructor activating the default information of the language.
__construct( lang = null, debug = false) :
| since |
1.7.0 |
|---|
Arguments
- lang
stringThe language- debug
boolIndicates if language debugging is enabled.
Response
mixed
debugFile
Debugs a language file
debugFile( filename) :
| since |
3.6.3 |
|---|---|
| throws |
|
Arguments
- filename
stringAbsolute path to the file to debug
Response
intA count of the number of parsing errors
get
Get a metadata language property.
get( property, default = null) :
| since |
1.7.0 |
|---|
Arguments
- property
stringThe name of the property.- default
mixedThe default value.
Response
mixedThe value of the property.
getCalendar
Getter for the calendar type
getCalendar() :
| since |
3.7.0 |
|---|
Response
stringThe calendar type.
getCallerInfo
Determine who called Language or Text.
getCallerInfo() : mixed||string|int
| since |
1.7.0 |
|---|
Response
array<string|int, mixed>Caller information.
getDebug
Get the Debug property.
getDebug() :
| since |
1.7.0 |
|---|
Response
boolTrue is in debug mode.
getDefault
Get the default language code.
getDefault() :
| since |
1.7.0 |
|---|
Response
stringLanguage code.
getErrorFiles
Get a list of language files that are in error state.
getErrorFiles() : mixed||string|int
| since |
1.7.0 |
|---|
Response
array<string|int, mixed>
getFirstDay
Get the first day of the week for this language.
getFirstDay() :
| since |
1.7.0 |
|---|
Response
intThe first day of the week according to the language
getIgnoredSearchWords
Returns an array of ignored search words
getIgnoredSearchWords() : mixed||string|int
| since |
1.7.0 |
|---|---|
| deprecated |
4.4 will be removed in 6.0 without replacement |
Response
array<string|int, mixed>The array of ignored search words.
getIgnoredSearchWordsCallback
Getter for ignoredSearchWordsCallback function.
getIgnoredSearchWordsCallback() Warning: Array to string conversion in /opt/phpdoc/vendor/twig/twig/src/Extension/CoreExtension.php on line 768 : |Array
| since |
1.7.0 |
|---|---|
| deprecated |
4.4 will be removed in 6.0 without replacement |
Response
callableFunction name or the actual function.
getInstance
Returns a language object.
getInstance( lang, debug = false) : \Joomla\CMS\Language\Language
| since |
1.7.0 |
|---|---|
| deprecated |
4.3 will be removed in 6.0 Use the language factory instead Example: Factory::getContainer()->get(LanguageFactoryInterface::class)->createLanguage($lang, $debug); |
Arguments
- lang
stringThe language to use.- debug
boolThe debug mode.
Response
LanguageThe Language object.
getLocale
Get the language locale based on current language.
getLocale() : mixed||string|int
| since |
1.7.0 |
|---|
Response
array<string|int, mixed>The locale according to the language.
getLowerLimitSearchWord
Returns a lower limit integer for length of search words
getLowerLimitSearchWord() :
| since |
1.7.0 |
|---|---|
| deprecated |
4.4 will be removed in 6.0 without replacement |
Response
intThe lower limit integer for length of search words (3 if no value was set for a specific language).
getLowerLimitSearchWordCallback
Getter for lowerLimitSearchWordCallback function
getLowerLimitSearchWordCallback() Warning: Array to string conversion in /opt/phpdoc/vendor/twig/twig/src/Extension/CoreExtension.php on line 768 : |Array
| since |
1.7.0 |
|---|---|
| deprecated |
4.4 will be removed in 6.0 without replacement |
Response
callableFunction name or the actual function.
getName
Getter for Name.
getName() :
| since |
1.7.0 |
|---|
Response
stringOfficial name element of the language.
getOrphans
Get the list of orphaned strings if being tracked.
getOrphans() : mixed||string|int
| since |
1.7.0 |
|---|
Response
array<string|int, mixed>Orphaned text.
getPaths
Get a list of language files that have been loaded.
getPaths( extension = null) : mixed||string|int
| since |
1.7.0 |
|---|
Arguments
- extension
stringAn optional extension name.
Response
array<string|int, mixed>
getPluralSuffixes
Returns an array of suffixes for plural rules.
getPluralSuffixes( count) : mixed||string|int
| since |
1.7.0 |
|---|
Arguments
- count
intThe count number the rule is for.
Response
array<string|int, mixed>The array of suffixes.
getPluralSuffixesCallback
Getter for pluralSuffixesCallback function.
getPluralSuffixesCallback() Warning: Array to string conversion in /opt/phpdoc/vendor/twig/twig/src/Extension/CoreExtension.php on line 768 : |Array
| since |
1.7.0 |
|---|
Response
callableFunction name or the actual function.
getSearchDisplayedCharactersNumber
Returns the number of characters displayed in search results.
getSearchDisplayedCharactersNumber() :
| since |
1.7.0 |
|---|---|
| deprecated |
4.4 will be removed in 6.0 without replacement |
Response
intThe number of characters displayed (200 if no value was set for a specific language).
getSearchDisplayedCharactersNumberCallback
Getter for searchDisplayedCharactersNumberCallback function
getSearchDisplayedCharactersNumberCallback() Warning: Array to string conversion in /opt/phpdoc/vendor/twig/twig/src/Extension/CoreExtension.php on line 768 : |Array
| since |
1.7.0 |
|---|---|
| deprecated |
4.4 will be removed in 6.0 without replacement |
Response
callableFunction name or the actual function.
getTag
Getter for the language tag (as defined in RFC 3066)
getTag() :
| since |
1.7.0 |
|---|
Response
stringThe language tag.
getTrace
Get a back trace.
getTrace() : mixed||string|int
| since |
4.0.0 |
|---|
Response
array<string|int, mixed>
getTransliterator
Getter for transliteration function
getTransliterator() Warning: Array to string conversion in /opt/phpdoc/vendor/twig/twig/src/Extension/CoreExtension.php on line 768 : |Array
| since |
1.7.0 |
|---|
Response
callableThe transliterator function
getUpperLimitSearchWord
Returns an upper limit integer for length of search words
getUpperLimitSearchWord() :
| since |
1.7.0 |
|---|---|
| deprecated |
4.4 will be removed in 6.0 without replacement |
Response
intThe upper limit integer for length of search words (200 if no value was set or if default value is < 200).
getUpperLimitSearchWordCallback
Getter for upperLimitSearchWordCallback function
getUpperLimitSearchWordCallback() Warning: Array to string conversion in /opt/phpdoc/vendor/twig/twig/src/Extension/CoreExtension.php on line 768 : |Array
| since |
1.7.0 |
|---|---|
| deprecated |
4.4 will be removed in 6.0 without replacement |
Response
callableFunction name or the actual function.
getUsed
Get the list of used strings.
getUsed() : mixed||string|int
Used strings are those strings requested and found either as a string or a constant.
| since |
1.7.0 |
|---|
Response
array<string|int, mixed>Used strings.
getWeekEnd
Get the weekends days for this language.
getWeekEnd() :
| since |
3.2 |
|---|
Response
stringThe weekend days of the week separated by a comma according to the language
hasKey
Determines is a key exists.
hasKey( string) :
| since |
1.7.0 |
|---|
Arguments
- string
stringThe key to check.
Response
boolTrue, if the key exists.
isRtl
Get the RTL property.
isRtl() :
| since |
1.7.0 |
|---|
Response
boolTrue is it an RTL language.
load
Loads a single language file and appends the results to the existing strings
load( extension = 'joomla', basePath = JPATH_BASE, lang = null, reload = false, default = true) :
| since |
1.7.0 |
|---|
Arguments
- extension
stringThe extension for which a language file should be loaded.- basePath
stringThe basepath to use.- lang
stringThe language to load, default null for the current language.- reload
boolFlag that will force a language to be reloaded if set to true.- default
boolFlag that force the default language to be loaded if the current does not exist.
Response
boolTrue if the file has successfully loaded.
loadLanguage
Loads a language file.
loadLanguage( fileName, extension = 'unknown') :
This method will not note the successful loading of a file - use load() instead.
| see | Language::load() |
|---|---|
| since |
1.7.0 |
Arguments
- fileName
stringThe name of the file.- extension
stringThe name of the extension.
Response
boolTrue if new strings have been added to the language
parse
Parses a language file.
parse( fileName) : mixed||string|int
| since |
1.7.0 |
|---|
Arguments
- fileName
stringThe name of the file.
Response
array<string|int, mixed>The array of parsed strings.
setDebug
Set the Debug property.
setDebug( debug) :
| since |
1.7.0 |
|---|
Arguments
- debug
boolThe debug setting.
Response
boolPrevious value.
setDefault
Set the default language code.
setDefault( lang) :
| since |
1.7.0 |
|---|
Arguments
- lang
stringThe language code.
Response
stringPrevious value.
setIgnoredSearchWordsCallback
Setter for the ignoredSearchWordsCallback function
setIgnoredSearchWordsCallback( Warning: Array to string conversion in /opt/phpdoc/vendor/twig/twig/src/Extension/CoreExtension.php on line 768 |Array function) Warning: Array to string conversion in /opt/phpdoc/vendor/twig/twig/src/Extension/CoreExtension.php on line 768 : |Array
| since |
1.7.0 |
|---|---|
| deprecated |
4.4 will be removed in 6.0 without replacement |
Arguments
- function
callableFunction name or actual function.
Response
callableThe previous function.
setLowerLimitSearchWordCallback
Setter for the lowerLimitSearchWordCallback function.
setLowerLimitSearchWordCallback( Warning: Array to string conversion in /opt/phpdoc/vendor/twig/twig/src/Extension/CoreExtension.php on line 768 |Array function) Warning: Array to string conversion in /opt/phpdoc/vendor/twig/twig/src/Extension/CoreExtension.php on line 768 : |Array
| since |
1.7.0 |
|---|---|
| deprecated |
4.4 will be removed in 6.0 without replacement |
Arguments
- function
callableFunction name or actual function.
Response
callableThe previous function.
setPluralSuffixesCallback
Set the pluralSuffixes function.
setPluralSuffixesCallback( Warning: Array to string conversion in /opt/phpdoc/vendor/twig/twig/src/Extension/CoreExtension.php on line 768 |Array function) Warning: Array to string conversion in /opt/phpdoc/vendor/twig/twig/src/Extension/CoreExtension.php on line 768 : |Array
| since |
1.7.0 |
|---|
Arguments
- function
callableFunction name or actual function.
Response
callableThe previous function.
setSearchDisplayedCharactersNumberCallback
Setter for the searchDisplayedCharactersNumberCallback function.
setSearchDisplayedCharactersNumberCallback( Warning: Array to string conversion in /opt/phpdoc/vendor/twig/twig/src/Extension/CoreExtension.php on line 768 |Array function) Warning: Array to string conversion in /opt/phpdoc/vendor/twig/twig/src/Extension/CoreExtension.php on line 768 : |Array
| since |
1.7.0 |
|---|---|
| deprecated |
4.4 will be removed in 6.0 without replacement |
Arguments
- function
callableFunction name or the actual function.
Response
callableThe previous function.
setTransliterator
Set the transliteration function.
setTransliterator( Warning: Array to string conversion in /opt/phpdoc/vendor/twig/twig/src/Extension/CoreExtension.php on line 768 |Array function) Warning: Array to string conversion in /opt/phpdoc/vendor/twig/twig/src/Extension/CoreExtension.php on line 768 : |Array
| since |
1.7.0 |
|---|
Arguments
- function
callableFunction name or the actual function.
Response
callableThe previous function.
setUpperLimitSearchWordCallback
Setter for the upperLimitSearchWordCallback function
setUpperLimitSearchWordCallback( Warning: Array to string conversion in /opt/phpdoc/vendor/twig/twig/src/Extension/CoreExtension.php on line 768 |Array function) Warning: Array to string conversion in /opt/phpdoc/vendor/twig/twig/src/Extension/CoreExtension.php on line 768 : |Array
| since |
1.7.0 |
|---|---|
| deprecated |
4.4 will be removed in 6.0 without replacement |
Arguments
- function
callableFunction name or the actual function.
Response
callableThe previous function.
transliterate
Transliterate function
transliterate( string) :
This method processes a string and replaces all accented UTF-8 characters by unaccented ASCII-7 "equivalents".
| since |
1.7.0 |
|---|
Arguments
- string
stringThe string to transliterate.
Response
stringThe transliteration of the string.
Properties
debug
Debug language, If true, highlights if string isn't found.
| since |
1.7.0 |
|---|
Type(s)
bool
default
The default language, used when a language file in the requested language does not exist.
| since |
1.7.0 |
|---|
Type(s)
string
orphans
An array of orphaned text.
| since |
1.7.0 |
|---|
Type(s)
array<string|int, mixed>
metadata
Array holding the language metadata.
| since |
1.7.0 |
|---|
Type(s)
array<string|int, mixed>
locale
Array holding the language locale or boolean null if none.
| since |
1.7.0 |
|---|
Type(s)
array<string|int, mixed>|bool
lang
The language to load.
| since |
1.7.0 |
|---|
Type(s)
string
paths
A nested array of language files that have been loaded
| since |
1.7.0 |
|---|
Type(s)
array<string|int, mixed>
errorfiles
List of language files that are in error state
| since |
1.7.0 |
|---|
Type(s)
array<string|int, mixed>
strings
Translations
| since |
1.7.0 |
|---|
Type(s)
array<string|int, mixed>
used
An array of used text, used during debugging.
| since |
1.7.0 |
|---|
Type(s)
array<string|int, mixed>
counter
Counter for number of loads.
| since |
1.7.0 |
|---|
Type(s)
int
override
An array used to store overrides.
| since |
1.7.0 |
|---|
Type(s)
array<string|int, mixed>
transliterator
Name of the transliterator function for this language.
| since |
1.7.0 |
|---|
Type(s)
callable
pluralSuffixesCallback
Name of the pluralSuffixesCallback function for this language.
| since |
1.7.0 |
|---|
Type(s)
callable
ignoredSearchWordsCallback
Name of the ignoredSearchWordsCallback function for this language.
| since |
1.7.0 |
|---|---|
| deprecated |
4.4 will be removed in 6.0 without replacement |
Type(s)
callable
lowerLimitSearchWordCallback
Name of the lowerLimitSearchWordCallback function for this language.
| since |
1.7.0 |
|---|---|
| deprecated |
4.4 will be removed in 6.0 without replacement |
Type(s)
callable
upperLimitSearchWordCallback
Name of the upperLimitSearchWordCallback function for this language.
| since |
1.7.0 |
|---|---|
| deprecated |
4.4 will be removed in 6.0 without replacement |
Type(s)
callable
searchDisplayedCharactersNumberCallback
Name of the searchDisplayedCharactersNumberCallback function for this language.
| since |
1.7.0 |
|---|---|
| deprecated |
4.4 will be removed in 6.0 without replacement |
Type(s)
callable