Joomla! API

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: stringThe string to translate
$jsSafe: booleanMake the result javascript safe
$interpretBackSlashes: booleanInterpret \t and \n

Response

stringThe translation of the string

Constructor activating the default information of the language.

__construct(string $lang = null, boolean $debug = false)

since	1.7.0

Arguments

$lang: stringThe language
$debug: booleanIndicates if language debugging is enabled.

Debugs a language file

debugFile(string $filename) : integer

since	3.6.3
throws	`\InvalidArgumentException`

Arguments

$filename: stringAbsolute path to the file to debug

Response

integerA count of the number of parsing errors

Checks if a language exists.

exists(string $lang, string $basePath = JPATH_BASE) : boolean

static deprecated

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: stringLanguage to check.
$basePath: stringOptional path to check.

Response

booleanTrue if the language exists.

Get a metadata language property.

get(string $property, mixed $default = null) : mixed

since	1.7.0

Arguments

$property: stringThe name of the property.
$default: mixedThe default value.

Response

mixedThe value of the property.

Getter for the calendar type

getCalendar() : string

since	3.7.0

Response

stringThe calendar type.

Determine who called Language or JText.

getCallerInfo() : array

since	1.7.0

Response

arrayCaller information.

Get the Debug property.

getDebug() : boolean

since	1.7.0

Response

booleanTrue is in debug mode.

Get the default language code.

getDefault() : string

since	1.7.0

Response

stringLanguage code.

Get a list of language files that are in error state.

getErrorFiles() : array

since	1.7.0

Response

array

Get the first day of the week for this language.

getFirstDay() : integer

since	1.7.0

Response

integerThe first day of the week according to the language

Returns an array of ignored search words

getIgnoredSearchWords() : array

since	1.7.0

Response

arrayThe array of ignored search words.

Getter for ignoredSearchWordsCallback function.

getIgnoredSearchWordsCallback() : callable

since	1.7.0

Response

callableFunction name or the actual function.

Returns a language object.

getInstance(string $lang, boolean $debug = false) : \Joomla\CMS\Language\Language

static

since	1.7.0

Arguments

$lang: stringThe language to use.
$debug: booleanThe debug mode.

Response

\Joomla\CMS\Language\LanguageThe Language object.

Returns a list of known languages for an area

getKnownLanguages(string $basePath = JPATH_BASE) : array

static deprecated

since	1.7.0
deprecated	3.7.0, use LanguageHelper::getKnownLanguages() instead.

Arguments

$basePath: stringThe basepath to use

Response

arraykey/value pair with the language file and real name.

Get the path to a language

getLanguagePath(string $basePath = JPATH_BASE, string $language = null) : string

static deprecated

since	1.7.0
deprecated	3.7.0, use LanguageHelper::getLanguagePath() instead.

Arguments

$basePath: stringThe basepath to use.
$language: stringThe language tag.

Response

stringlanguage related path or null.

Get the language locale based on current language.

getLocale() : array

since	1.7.0

Response

arrayThe locale according to the language.

Returns a lower limit integer for length of search words

getLowerLimitSearchWord() : integer

since	1.7.0

Response

integerThe lower limit integer for length of search words (3 if no value was set for a specific language).

Getter for lowerLimitSearchWordCallback function

getLowerLimitSearchWordCallback() : callable

since	1.7.0

Response

callableFunction name or the actual function.

Returns an associative array holding the metadata.

getMetadata(string $lang) : mixed

static deprecated

since	1.7.0
deprecated	3.7.0, use LanguageHelper::getMetadata() instead.

Arguments

$lang: stringThe name of the language.

Response

mixedIf $lang exists return key/value pair with the language metadata, otherwise return NULL.

Getter for Name.

getName() : string

since	1.7.0

Response

stringOfficial name element of the language.

Get the list of orphaned strings if being tracked.

getOrphans() : array

since	1.7.0

Response

arrayOrphaned text.

Get a list of language files that have been loaded.

getPaths(string $extension = null) : array

since	1.7.0

Arguments

$extension: stringAn optional extension name.

Response

array

Returns an array of suffixes for plural rules.

getPluralSuffixes(integer $count) : array

since	1.7.0

Arguments

$count: integerThe count number the rule is for.

Response

arrayThe array of suffixes.

Getter for pluralSuffixesCallback function.

getPluralSuffixesCallback() : callable

since	1.7.0

Response

callableFunction name or the actual function.

Returns the number of characters displayed in search results.

getSearchDisplayedCharactersNumber() : integer

since	1.7.0

Response

integerThe number of characters displayed (200 if no value was set for a specific language).

Getter for searchDisplayedCharactersNumberCallback function

getSearchDisplayedCharactersNumberCallback() : callable

since	1.7.0

Response

callableFunction name or the actual function.

Getter for the language tag (as defined in RFC 3066)

getTag() : string

since	1.7.0

Response

stringThe language tag.

Getter for transliteration function

getTransliterator() : callable

since	1.7.0

Response

callableThe transliterator function

Returns an upper limit integer for length of search words

getUpperLimitSearchWord() : integer

since	1.7.0

Response

integerThe upper limit integer for length of search words (200 if no value was set or if default value is < 200).

Getter for upperLimitSearchWordCallback function

getUpperLimitSearchWordCallback() : callable

since	1.7.0

Response

callableFunction name or the actual function.

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

arrayUsed strings.

Get the weekends days for this language.

getWeekEnd() : string

since	3.2

Response

stringThe weekend days of the week separated by a comma according to the language

Determines is a key exists.

hasKey(string $string) : boolean

since	1.7.0

Arguments

$string: stringThe key to check.

Response

booleanTrue, if the key exists.

Get the RTL property.

isRtl() : boolean

since	1.7.0

Response

booleanTrue is it an RTL language.

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: 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: booleanFlag that will force a language to be reloaded if set to true.
$default: booleanFlag that force the default language to be loaded if the current does not exist.

Response

booleanTrue if the file has successfully loaded.

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: stringThe name of the file.
$extension: stringThe name of the extension.

Response

booleanTrue if new strings have been added to the language

Parses a language file.

parse(string $fileName) : array

since	1.7.0

Arguments

$fileName: stringThe name of the file.

Response

arrayThe array of parsed strings.

Searches for language directories within a certain base dir.

parseLanguageFiles(string $dir = null) : array

static deprecated

since	1.7.0
deprecated	3.7.0, use LanguageHelper::parseLanguageFiles() instead.

Arguments

$dir: stringdirectory of files.

Response

arrayArray holding the found languages as filename => real name pairs.

Parse XML file for language information.

parseXMLLanguageFile(string $path) : array

static deprecated

since	1.7.0
throws	`\RuntimeException`
deprecated	3.7.0, use LanguageHelper::parseXMLLanguageFile() instead.

Arguments

$path: stringPath to the XML files.

Response

arrayArray holding the found metadata as a key => value pair.

Set the Debug property.

setDebug(boolean $debug) : boolean

since	1.7.0

Arguments

$debug: booleanThe debug setting.

Response

booleanPrevious value.

Set the default language code.

setDefault(string $lang) : string

since	1.7.0

Arguments

$lang: stringThe language code.

Response

stringPrevious value.

Setter for the ignoredSearchWordsCallback function

setIgnoredSearchWordsCallback(callable $function) : callable

since	1.7.0

Arguments

$function: callableFunction name or actual function.

Response

callableThe previous function.

Set the language attributes to the given language.

setLanguage(string $lang) : string

deprecated

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: stringLanguage code.

Response

stringPrevious value.

Setter for the lowerLimitSearchWordCallback function.

setLowerLimitSearchWordCallback(callable $function) : callable

since	1.7.0

Arguments

$function: callableFunction name or actual function.

Response

callableThe previous function.

Set the pluralSuffixes function.

setPluralSuffixesCallback(callable $function) : callable

since	1.7.0

Arguments

$function: callableFunction name or actual function.

Response

callableThe previous function.

Setter for the searchDisplayedCharactersNumberCallback function.

setSearchDisplayedCharactersNumberCallback(callable $function) : callable

since	1.7.0

Arguments

$function: callableFunction name or the actual function.

Response

callableThe previous function.

Set the transliteration function.

setTransliterator(callable $function) : callable

since	1.7.0

Arguments

$function: callableFunction name or the actual function.

Response

callableThe previous function.

Setter for the upperLimitSearchWordCallback function

setUpperLimitSearchWordCallback(callable $function) : callable

since	1.7.0

Arguments

$function: callableFunction name or the actual function.

Response

callableThe previous function.

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: stringThe string to transliterate.

Response

stringThe transliteration of the string.

Array of Language objects

static

since	1.7.0

Type(s)

array<mixed,\Joomla\CMS\Language\Language>

Debug language, If true, highlights if string isn't found.

since	1.7.0

Type(s)

boolean

The default language, used when a language file in the requested language does not exist.

since	1.7.0

Type(s)

string

An array of orphaned text.

since	1.7.0

Type(s)

array

Array holding the language metadata.

since	1.7.0

Type(s)

array

Array holding the language locale or boolean null if none.

since	1.7.0

Type(s)

array|boolean

The language to load.

since	1.7.0

Type(s)

string

A nested array of language files that have been loaded

since	1.7.0

Type(s)

array

List of language files that are in error state

since	1.7.0

Type(s)

array

Translations

since	1.7.0

Type(s)

array

An array of used text, used during debugging.

since	1.7.0

Type(s)

array

Counter for number of loads.

since	1.7.0

Type(s)

integer

An array used to store overrides.

since	1.7.0

Type(s)

array

Name of the transliterator function for this language.

since	1.7.0

Type(s)

string

Name of the pluralSuffixesCallback function for this language.

since	1.7.0

Type(s)

callable

Name of the ignoredSearchWordsCallback function for this language.

since	1.7.0

Type(s)

callable

Name of the lowerLimitSearchWordCallback function for this language.

since	1.7.0

Type(s)

callable

Name of the upperLimitSearchWordCallback function for this language.

since	1.7.0

Type(s)

callable

Name of the searchDisplayedCharactersNumberCallback function for this language.

since	1.7.0

Type(s)

callable

Language

Methods

_

Arguments

Response

__construct

Arguments

debugFile

Arguments

Response

exists

Arguments

Response

get

Arguments

Response

getCalendar

Response

getCallerInfo

Response

getDebug

Response

getDefault

Response

getErrorFiles

Response

getFirstDay

Response

getIgnoredSearchWords

Response

getIgnoredSearchWordsCallback

Response

getInstance

Arguments

Response

getKnownLanguages

Arguments

Response

getLanguagePath

Arguments

Response

getLocale

Response

getLowerLimitSearchWord

Response

getLowerLimitSearchWordCallback

Response

getMetadata

Arguments

Response

getName

Response

getOrphans

Response

getPaths

Arguments

Response

getPluralSuffixes

Arguments

Response

getPluralSuffixesCallback

Response

getSearchDisplayedCharactersNumber

Response

getSearchDisplayedCharactersNumberCallback

Response

getTag

Response

getTransliterator

Response

getUpperLimitSearchWord

Response

getUpperLimitSearchWordCallback

Response

getUsed

Response

getWeekEnd

Response

hasKey

Arguments