LanguageHelper
Language helper class
since |
1.5 |
---|---|
package |
Joomla CMS |
Methods
createLanguageList
Builds a list of the system languages which can be used in a select option
createLanguageList( actualLanguage, basePath = JPATH_BASE, caching = false, installed = false) : mixed||string|int
since |
1.5 |
---|
Arguments
- actualLanguage
string
Client key for the area- basePath
string
Base path to use- caching
bool
True if caching is used- installed
bool
Get only installed languages
Response
array<string|int, mixed>
List of system languages
detectLanguage
Tries to detect the language.
detectLanguage() :
since |
1.5 |
---|
Response
string
locale or null if not found
exists
Checks if a language exists.
exists( lang, basePath = JPATH_BASE) :
This is a simple, quick check for the directory that should contain language files for the given user.
since |
3.7.0 |
---|
Arguments
- lang
string
Language to check.- basePath
string
Optional path to check.
Response
bool
True if the language exists.
getContentLanguages
Get a list of content languages.
getContentLanguages(mixed||string|int publishedStates = [1], checkInstalled = true, pivot = 'lang_code', orderField = null, orderDirection = null) : mixed||string|int
since |
3.7.0 |
---|
Arguments
- publishedStates
array<string|int, mixed>
Array with the content language published states. Empty array for all.- checkInstalled
bool
Check if the content language is installed.- pivot
string
The pivot of the returning array.- orderField
string
Field to order the results.- orderDirection
string
Direction to order the results.
Response
array<string|int, mixed>
Array of the content languages.
getInstalledLanguages
Get a list of installed languages.
getInstalledLanguages( clientId = null, processMetaData = false, processManifest = false, pivot = 'element', orderField = null, orderDirection = null) : mixed||string|int
since |
3.7.0 |
---|
Arguments
- clientId
int
The client app id.- processMetaData
bool
Fetch Language metadata.- processManifest
bool
Fetch Language manifest.- pivot
string
The pivot of the returning array.- orderField
string
Field to order the results.- orderDirection
string
Direction to order the results.
Response
array<string|int, mixed>
Array with the installed languages.
getKnownLanguages
Returns a list of known languages for an area
getKnownLanguages( basePath = JPATH_BASE) : mixed||string|int
since |
3.7.0 |
---|
Arguments
- basePath
string
The basepath to use
Response
array<string|int, mixed>
key/value pair with the language file and real name.
getLanguagePath
Get the path to a language
getLanguagePath( basePath = JPATH_BASE, language = null) :
since |
3.7.0 |
---|
Arguments
- basePath
string
The basepath to use.- language
string
The language tag.
Response
string
language related path or null.
getLanguages
Get available languages
getLanguages( key = 'default') : mixed||string|int
since |
1.6 |
---|
Arguments
- key
string
Array key
Response
array<string|int, mixed>
An array of published languages
getMetadata
Returns an associative array holding the metadata.
getMetadata( lang) :
since |
3.7.0 |
---|
Arguments
- lang
string
The name of the language.
Response
mixed
If $lang exists return key/value pair with the language metadata, otherwise return NULL.
parseIniFile
Parse strings from a language file.
parseIniFile( fileName, debug = false) : mixed||string|int
since |
3.9.0 |
---|
Arguments
- fileName
string
The language ini file path.- debug
bool
If set to true debug language ini file.
Response
array<string|int, mixed>
The strings parsed.
parseLanguageFiles
Searches for language directories within a certain base dir.
parseLanguageFiles( dir = null) : mixed||string|int
since |
3.7.0 |
---|
Arguments
- dir
string
directory of files.
Response
array<string|int, mixed>
Array holding the found languages as filename => real name pairs.
parseXMLLanguageFile
Parse XML file for language information.
parseXMLLanguageFile( path) : mixed||string|int
since |
3.7.0 |
---|---|
throws |
|
Arguments
- path
string
Path to the XML files.
Response
array<string|int, mixed>
Array holding the found metadata as a key => value pair.
saveToIniFile
Save strings to a language file.
saveToIniFile( fileName, mixed||string|int strings) :
since |
3.7.0 |
---|
Arguments
- fileName
string
The language ini file path.- strings
array<string|int, mixed>
The array of strings.
Response
bool
True if saved, false otherwise.