Language
Languages/translation handler class
since |
1.7.0 |
---|
Methods
_
Translate function, mimics the php gettext (alias _) function.
_(string $string, boolean $jsSafe = false, boolean $interpretBackSlashes = true) : string
The function checks if $jsSafe is true, then if $interpretBackslashes is true.
since |
1.7.0 |
---|
Arguments
- $string
string
The string to translate- $jsSafe
boolean
Make the result javascript safe- $interpretBackSlashes
boolean
Interpret \t and \n
Response
string
The translation of the string
__construct
Constructor activating the default information of the language.
__construct(string $lang = null, boolean $debug = false)
since |
1.7.0 |
---|
Arguments
- $lang
string
The language- $debug
boolean
Indicates if language debugging is enabled.
debugFile
Debugs a language file
debugFile(string $filename) : integer
since |
3.6.3 |
---|---|
throws |
|
Arguments
- $filename
string
Absolute path to the file to debug
Response
integer
A count of the number of parsing errors
exists
Checks if a language exists.
exists(string $lang, string $basePath = JPATH_BASE) : boolean
This is a simple, quick check for the directory that should contain language files for the given user.
since |
1.7.0 |
---|---|
deprecated |
3.7.0, use LanguageHelper::exists() instead. |
Arguments
- $lang
string
Language to check.- $basePath
string
Optional path to check.
Response
boolean
True if the language exists.
get
Get a metadata language property.
get(string $property, mixed $default = null) : mixed
since |
1.7.0 |
---|
Arguments
- $property
string
The name of the property.- $default
mixed
The default value.
Response
mixed
The value of the property.
getCalendar
Getter for the calendar type
getCalendar() : string
since |
3.7.0 |
---|
Response
string
The calendar type.
getCallerInfo
Determine who called Language or JText.
getCallerInfo() : array
since |
1.7.0 |
---|
Response
array
Caller information.
getDebug
Get the Debug property.
getDebug() : boolean
since |
1.7.0 |
---|
Response
boolean
True is in debug mode.
getDefault
Get the default language code.
getDefault() : string
since |
1.7.0 |
---|
Response
string
Language code.
getErrorFiles
Get a list of language files that are in error state.
getErrorFiles() : array
since |
1.7.0 |
---|
Response
array
getFirstDay
Get the first day of the week for this language.
getFirstDay() : integer
since |
1.7.0 |
---|
Response
integer
The first day of the week according to the language
getIgnoredSearchWords
Returns an array of ignored search words
getIgnoredSearchWords() : array
since |
1.7.0 |
---|
Response
array
The array of ignored search words.
getIgnoredSearchWordsCallback
Getter for ignoredSearchWordsCallback function.
getIgnoredSearchWordsCallback() : callable
since |
1.7.0 |
---|
Response
callable
Function name or the actual function.
getInstance
Returns a language object.
getInstance(string $lang, boolean $debug = false) : \Joomla\CMS\Language\Language
since |
1.7.0 |
---|
Arguments
- $lang
string
The language to use.- $debug
boolean
The debug mode.
Response
\Joomla\CMS\Language\Language
The Language object.
getKnownLanguages
Returns a list of known languages for an area
getKnownLanguages(string $basePath = JPATH_BASE) : array
since |
1.7.0 |
---|---|
deprecated |
3.7.0, use LanguageHelper::getKnownLanguages() instead. |
Arguments
- $basePath
string
The basepath to use
Response
array
key/value pair with the language file and real name.
getLanguagePath
Get the path to a language
getLanguagePath(string $basePath = JPATH_BASE, string $language = null) : string
since |
1.7.0 |
---|---|
deprecated |
3.7.0, use LanguageHelper::getLanguagePath() instead. |
Arguments
- $basePath
string
The basepath to use.- $language
string
The language tag.
Response
string
language related path or null.
getLocale
Get the language locale based on current language.
getLocale() : array
since |
1.7.0 |
---|
Response
array
The locale according to the language.
getLowerLimitSearchWord
Returns a lower limit integer for length of search words
getLowerLimitSearchWord() : integer
since |
1.7.0 |
---|
Response
integer
The lower limit integer for length of search words (3 if no value was set for a specific language).
getLowerLimitSearchWordCallback
Getter for lowerLimitSearchWordCallback function
getLowerLimitSearchWordCallback() : callable
since |
1.7.0 |
---|
Response
callable
Function name or the actual function.
getMetadata
Returns an associative array holding the metadata.
getMetadata(string $lang) : mixed
since |
1.7.0 |
---|---|
deprecated |
3.7.0, use LanguageHelper::getMetadata() instead. |
Arguments
- $lang
string
The name of the language.
Response
mixed
If $lang exists return key/value pair with the language metadata, otherwise return NULL.
getName
Getter for Name.
getName() : string
since |
1.7.0 |
---|
Response
string
Official name element of the language.
getOrphans
Get the list of orphaned strings if being tracked.
getOrphans() : array
since |
1.7.0 |
---|
Response
array
Orphaned text.
getPaths
Get a list of language files that have been loaded.
getPaths(string $extension = null) : array
since |
1.7.0 |
---|
Arguments
- $extension
string
An optional extension name.
Response
array
getPluralSuffixes
Returns an array of suffixes for plural rules.
getPluralSuffixes(integer $count) : array
since |
1.7.0 |
---|
Arguments
- $count
integer
The count number the rule is for.
Response
array
The array of suffixes.
getPluralSuffixesCallback
Getter for pluralSuffixesCallback function.
getPluralSuffixesCallback() : callable
since |
1.7.0 |
---|
Response
callable
Function name or the actual function.
getSearchDisplayedCharactersNumber
Returns the number of characters displayed in search results.
getSearchDisplayedCharactersNumber() : integer
since |
1.7.0 |
---|
Response
integer
The number of characters displayed (200 if no value was set for a specific language).
getSearchDisplayedCharactersNumberCallback
Getter for searchDisplayedCharactersNumberCallback function
getSearchDisplayedCharactersNumberCallback() : callable
since |
1.7.0 |
---|
Response
callable
Function name or the actual function.
getTag
Getter for the language tag (as defined in RFC 3066)
getTag() : string
since |
1.7.0 |
---|
Response
string
The language tag.
getTransliterator
Getter for transliteration function
getTransliterator() : callable
since |
1.7.0 |
---|
Response
callable
The transliterator function
getUpperLimitSearchWord
Returns an upper limit integer for length of search words
getUpperLimitSearchWord() : integer
since |
1.7.0 |
---|
Response
integer
The 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() : callable
since |
1.7.0 |
---|
Response
callable
Function name or the actual function.
getUsed
Get the list of used strings.
getUsed() : array
Used strings are those strings requested and found either as a string or a constant.
since |
1.7.0 |
---|
Response
array
Used strings.
getWeekEnd
Get the weekends days for this language.
getWeekEnd() : string
since |
3.2 |
---|
Response
string
The weekend days of the week separated by a comma according to the language
hasKey
Determines is a key exists.
hasKey(string $string) : boolean
since |
1.7.0 |
---|
Arguments
- $string
string
The key to check.
Response
boolean
True, if the key exists.
isRtl
Get the RTL property.
isRtl() : boolean
since |
1.7.0 |
---|
Response
boolean
True is it an RTL language.
load
Loads a single language file and appends the results to the existing strings
load(string $extension = 'joomla', string $basePath = JPATH_BASE, string $lang = null, boolean $reload = false, boolean $default = true) : boolean
since |
1.7.0 |
---|
Arguments
- $extension
string
The extension for which a language file should be loaded.- $basePath
string
The basepath to use.- $lang
string
The language to load, default null for the current language.- $reload
boolean
Flag that will force a language to be reloaded if set to true.- $default
boolean
Flag that force the default language to be loaded if the current does not exist.
Response
boolean
True if the file has successfully loaded.
loadLanguage
Loads a language file.
loadLanguage(string $fileName, string $extension = 'unknown') : boolean
This method will not note the successful loading of a file - use load() instead.
see | \Joomla\CMS\Language\Language::load() |
---|---|
since |
1.7.0 |
Arguments
- $fileName
string
The name of the file.- $extension
string
The name of the extension.
Response
boolean
True if new strings have been added to the language
parse
Parses a language file.
parse(string $fileName) : array
since |
1.7.0 |
---|
Arguments
- $fileName
string
The name of the file.
Response
array
The array of parsed strings.
parseLanguageFiles
Searches for language directories within a certain base dir.
parseLanguageFiles(string $dir = null) : array
since |
1.7.0 |
---|---|
deprecated |
3.7.0, use LanguageHelper::parseLanguageFiles() instead. |
Arguments
- $dir
string
directory of files.
Response
array
Array holding the found languages as filename => real name pairs.
parseXMLLanguageFile
Parse XML file for language information.
parseXMLLanguageFile(string $path) : array
since |
1.7.0 |
---|---|
throws |
|
deprecated |
3.7.0, use LanguageHelper::parseXMLLanguageFile() instead. |
Arguments
- $path
string
Path to the XML files.
Response
array
Array holding the found metadata as a key => value pair.
setDebug
Set the Debug property.
setDebug(boolean $debug) : boolean
since |
1.7.0 |
---|
Arguments
- $debug
boolean
The debug setting.
Response
boolean
Previous value.
setDefault
Set the default language code.
setDefault(string $lang) : string
since |
1.7.0 |
---|
Arguments
- $lang
string
The language code.
Response
string
Previous value.
setIgnoredSearchWordsCallback
Setter for the ignoredSearchWordsCallback function
setIgnoredSearchWordsCallback(callable $function) : callable
since |
1.7.0 |
---|
Arguments
- $function
callable
Function name or actual function.
Response
callable
The previous function.
setLanguage
Set the language attributes to the given language.
setLanguage(string $lang) : string
Once called, the language still needs to be loaded using Language::load().
since |
1.7.0 |
---|---|
deprecated |
4.0 (CMS) - Instantiate a new Language object instead |
Arguments
- $lang
string
Language code.
Response
string
Previous value.
setLowerLimitSearchWordCallback
Setter for the lowerLimitSearchWordCallback function.
setLowerLimitSearchWordCallback(callable $function) : callable
since |
1.7.0 |
---|
Arguments
- $function
callable
Function name or actual function.
Response
callable
The previous function.
setPluralSuffixesCallback
Set the pluralSuffixes function.
setPluralSuffixesCallback(callable $function) : callable
since |
1.7.0 |
---|
Arguments
- $function
callable
Function name or actual function.
Response
callable
The previous function.
setSearchDisplayedCharactersNumberCallback
Setter for the searchDisplayedCharactersNumberCallback function.
setSearchDisplayedCharactersNumberCallback(callable $function) : callable
since |
1.7.0 |
---|
Arguments
- $function
callable
Function name or the actual function.
Response
callable
The previous function.
setTransliterator
Set the transliteration function.
setTransliterator(callable $function) : callable
since |
1.7.0 |
---|
Arguments
- $function
callable
Function name or the actual function.
Response
callable
The previous function.
setUpperLimitSearchWordCallback
Setter for the upperLimitSearchWordCallback function
setUpperLimitSearchWordCallback(callable $function) : callable
since |
1.7.0 |
---|
Arguments
- $function
callable
Function name or the actual function.
Response
callable
The previous function.
transliterate
Transliterate function
transliterate(string $string) : string
This method processes a string and replaces all accented UTF-8 characters by unaccented ASCII-7 "equivalents".
since |
1.7.0 |
---|
Arguments
- $string
string
The string to transliterate.
Response
string
The transliteration of the string.
Properties
languages
Array of Language objects
debug
Debug language, If true, highlights if string isn't found.
since |
1.7.0 |
---|
Type(s)
boolean
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
metadata
Array holding the language metadata.
since |
1.7.0 |
---|
Type(s)
array
locale
Array holding the language locale or boolean null if none.
since |
1.7.0 |
---|
Type(s)
array|boolean
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
errorfiles
List of language files that are in error state
since |
1.7.0 |
---|
Type(s)
array
strings
Translations
since |
1.7.0 |
---|
Type(s)
array
used
An array of used text, used during debugging.
since |
1.7.0 |
---|
Type(s)
array
counter
Counter for number of loads.
since |
1.7.0 |
---|
Type(s)
integer
override
An array used to store overrides.
since |
1.7.0 |
---|
Type(s)
array
transliterator
Name of the transliterator function for this language.
since |
1.7.0 |
---|
Type(s)
string
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 |
---|
Type(s)
callable
lowerLimitSearchWordCallback
Name of the lowerLimitSearchWordCallback function for this language.
since |
1.7.0 |
---|
Type(s)
callable
upperLimitSearchWordCallback
Name of the upperLimitSearchWordCallback function for this language.
since |
1.7.0 |
---|
Type(s)
callable
searchDisplayedCharactersNumberCallback
Name of the searchDisplayedCharactersNumberCallback function for this language.
since |
1.7.0 |
---|
Type(s)
callable