Joomla! API

package	Joomla.Platform
subpackage	Language
since	11.1

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	11.1

Arguments

$string: stringThe string to translate
$jsSafe: booleanMake the result javascript safe
$interpretBackSlashes: booleanInterpret \t and \n

Response

stringThe translation of the string

Class constructor, overridden in descendant classes.

__construct(mixed $properties = null)

inherited

since	11.1

Arguments

$properties: mixedEither and associative array or another object to set the initial properties of the object.

Magic method to convert the object to a string gracefully.

__toString() : string

inherited deprecated

since	11.1
deprecated	12.3 Classes should provide their own __toString() implementation.

Response

stringThe classname.

Searches for language directories within a certain base dir.

_parseLanguageFiles(string $dir = null) : array

static deprecated

deprecated	12.1
note	Use parseLanguageFiles instead.
since	11.1

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

deprecated	12.1
note	Use parseXMLLanguageFile instead.
since	11.1

Arguments

$path: stringPath to the XML files.

Response

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

Parses XML files for language information.

_parseXMLLanguageFiles(string $dir = null) : array

static deprecated

note	Use parseXMLLanguageFiles instead.
since	11.1
deprecated	12.1

Arguments

$dir: stringDirectory of files.

Response

arrayArray holding the found languages as filename => metadata array.

Sets a default value if not alreay assigned

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

inherited

since	11.1

Arguments

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

Response

mixed

Checks if a language exists.

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

static

This is a simple, quick check for the directory that should contain language files for the given user.

since	11.1

Arguments

$lang: stringLanguage to check.
$basePath: stringOptional path to check.

Response

booleanTrue if the language exists.

Returns a property of the object or the default value if the property is not set.

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

inherited

since	11.1
see	\JObject::getProperties()

Arguments

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

Response

mixedThe value of the property.

Determine who called JLanguage or JText.

getCallerInfo() : array

since	11.1

Response

arrayCaller information.

Get the Debug property.

getDebug() : boolean

since	11.1

Response

booleanTrue is in debug mode.

Get the default language code.

getDefault() : string

since	11.1

Response

stringLanguage code.

Get the most recent error message.

getError(integer $i = null, boolean $toString = true) : string

inherited deprecated

since	11.1
see	\JError
deprecated	12.3 JError has been deprecated

Arguments

$i: integerOption error index.
$toString: booleanIndicates if JError objects should return their error message.

Response

stringError message

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

getErrorFiles() : array

since	11.1

Response

array

Return all errors, if any.

getErrors() : array

inherited deprecated

since	11.1
see	\JError
deprecated	12.3 JError has been deprecated

Response

arrayArray of error messages or JErrors.

Get the first day of the week for this language.

getFirstDay() : integer

since	11.1

Response

integerThe first day of the week according to the language

Returns an array of ignored search words

getIgnoredSearchWords() : array

since	11.1

Response

arrayThe array of ignored search words.

Getter for ignoredSearchWordsCallback function.

getIgnoredSearchWordsCallback() : mixed

since	11.1

Response

mixedFunction name (string) or the actual function for PHP 5.3 (function).

Returns a language object.

getInstance(string $lang, boolean $debug = false) : \JLanguage

static

since	11.1

Arguments

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

Response

\JLanguageThe Language object.

Returns a list of known languages for an area

getKnownLanguages(string $basePath = JPATH_BASE) : array

static

since	11.1

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

since	11.1

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	11.1

Response

arrayThe locale according to the language.

Returns a lower limit integer for length of search words

getLowerLimitSearchWord() : integer

since	11.1

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() : mixed

since	11.1

Response

mixedFunction name (string) or the actual function for PHP 5.3 (function).

Returns a associative array holding the metadata.

getMetadata(string $lang) : mixed

static

since	11.1

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	11.1

Response

stringOfficial name element of the language.

Get the list of orphaned strings if being tracked.

getOrphans() : array

since	11.1

Response

arrayOrphaned text.

Get a list of language files that have been loaded.

getPaths(string $extension = null) : array

since	11.1

Arguments

$extension: stringAn optional extension name.

Response

array

Getter for pluralSuffixesCallback function.

getPluralSufficesCallback() : mixed

deprecated

since	11.1
deprecated	12.1
note	Use JLanguage::getPluralSuffixesCallback method instead

Response

mixedFunction name (string) or the actual function for PHP 5.3 (function).

Returns an array of suffixes for plural rules.

getPluralSuffixes(integer $count) : array

since	11.1

Arguments

$count: integerThe count number the rule is for.

Response

arrayThe array of suffixes.

Getter for pluralSuffixesCallback function.

getPluralSuffixesCallback() : mixed

since	11.1

Response

mixedFunction name (string) or the actual function for PHP 5.3 (function).

Returns an associative array of object properties.

getProperties(boolean $public = true) : array

inherited

since	11.1
see	\JObject::get()

Arguments

$public: booleanIf true, returns only the public properties.

Response

array

Returns the number of characters displayed in search results.

getSearchDisplayedCharactersNumber() : integer

since	11.1

Response

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

Getter for searchDisplayedCharactersNumberCallback function

getSearchDisplayedCharactersNumberCallback() : mixed

since	11.1

Response

mixedFunction name or the actual function for PHP 5.3.

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

getTag() : string

since	11.1

Response

stringThe language tag.

Getter for transliteration function

getTransliterator() : string

since	11.1

Response

stringFunction name or the actual function for PHP 5.3.

Returns an upper limit integer for length of search words

getUpperLimitSearchWord() : integer

since	11.1

Response

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

Getter for upperLimitSearchWordCallback function

getUpperLimitSearchWordCallback() : string|\function

since	11.1

Response

string|\functionFunction name or the actual function for PHP 5.3.

Get the list of used strings.

getUsed() : array

Used strings are those strings requested and found either as a string or a constant.

since	11.1

Response

arrayUsed strings.

Determines is a key exists.

hasKey(string $string) : boolean

since	11.1

Arguments

$string: stringThe key to check.

Response

booleanTrue, if the key exists.

Get the RTL property.

isRTL() : boolean

since	11.1

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	11.1

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 $overwrite = true) : boolean

This method will not note the successful loading of a file - use load() instead.

see	\JLanguage::load()
since	11.1

Arguments

$filename: stringThe name of the file.
$extension: stringThe name of the extension.
$overwrite: booleanNot used??

Response

booleanTrue if new strings have been added to the language

Parses a language file.

parse(string $filename) : array

since	11.1

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

since	11.1

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

since	11.1

Arguments

$path: stringPath to the XML files.

Response

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

Parses XML files for language information

parseXMLLanguageFiles(string $dir = null) : array

static

since	11.1

Arguments

$dir: stringDirectory of files.

Response

arrayArray holding the found languages as filename => metadata array.

Modifies a property of the object, creating it if it does not already exist.

set(string $property, mixed $value = null) : mixed

inherited

since	11.1

Arguments

$property: stringThe name of the property.
$value: mixedThe value of the property to set.

Response

mixedPrevious value of the property.

Set the Debug property.

setDebug(boolean $debug) : boolean

since	11.1

Arguments

$debug: booleanThe debug setting.

Response

booleanPrevious value.

Set the default language code.

setDefault(string $lang) : string

since	11.1

Arguments

$lang: stringThe language code.

Response

stringPrevious value.

Add an error message.

setError(string $error) : void

inherited deprecated

since	11.1
see	\JError
deprecated	12.3 JError has been deprecated

Arguments

$error: stringError message.

Setter for the ignoredSearchWordsCallback function

setIgnoredSearchWordsCallback(mixed $function) : mixed

since	11.1

Arguments

$function: mixedFunction name (string) or actual function for PHP 5.3 (function)

Response

mixedFunction name (string) or the actual function for PHP 5.3 (function)

Set the language attributes to the given language.

setLanguage(string $lang) : string

Once called, the language still needs to be loaded using JLanguage::load().

since	11.1

Arguments

$lang: stringLanguage code.

Response

stringPrevious value.

Setter for the lowerLimitSearchWordCallback function.

setLowerLimitSearchWordCallback(mixed $function) : string|\function

since	11.1

Arguments

$function: mixedFunction name (string) or actual function for PHP 5.3 (function)

Response

string|\functionFunction name or the actual function for PHP 5.3.

Set the pluralSuffixes function.

setPluralSuffixesCallback(mixed $function) : mixed

since	11.1

Arguments

$function: mixedFunction name (string) or actual function for PHP 5.3 (function)

Response

mixedFunction name or the actual function for PHP 5.3.

Set the object properties based on a named array/hash.

setProperties(mixed $properties) : boolean

inherited

since	11.1
see	\JObject::set()

Arguments

$properties: mixedEither an associative array or another object.

Response

boolean

Setter for the searchDisplayedCharactersNumberCallback function.

setSearchDisplayedCharactersNumberCallback(string $function) : mixed

since	11.1

Arguments

$function: stringThe name of the callback.

Response

mixedFunction name (string) or the actual function for PHP 5.3 (function).

Set the transliteration function.

setTransliterator(mixed $function) : mixed

since	11.1

Arguments

$function: mixedFunction name (string) or the actual function for PHP 5.3 (function).

Response

mixed

Setter for the upperLimitSearchWordCallback function

setUpperLimitSearchWordCallback(string $function) : mixed

since	11.1

Arguments

$function: stringThe name of the callback function.

Response

mixedFunction name (string) or the actual function for PHP 5.3 (function).

Converts the object to a string (the class name).

toString() : string

inherited deprecated

since	11.1
deprecated	12.1 Use magic method __toString()
see	\JObject::__toString()

Response

string

Transliterate function

transliterate(string $string) : string

This method processes a string and replaces all accented UTF-8 characters by unaccented ASCII-7 "equivalents".

since	11.1

Arguments

$string: stringThe string to transliterate.

Response

stringThe transliteration of the string.

static

Type(s)

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

since	11.1

Type(s)

boolean

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

since	11.1

Type(s)

string

An array of orphaned text.

since	11.1

Type(s)

array

Array holding the language metadata.

since	11.1

Type(s)

array

Array holding the language locale or boolean null if none.

since	11.1

Type(s)

array|boolean

The language to load.

since	11.1

Type(s)

string

A nested array of language files that have been loaded

since	11.1

Type(s)

array

List of language files that are in error state

since	11.1

Type(s)

array

Translations

since	11.1

Type(s)

array

An array of used text, used during debugging.

since	11.1

Type(s)

array

Counter for number of loads.

since	11.1

Type(s)

integer

An array used to store overrides.

since	11.1

Type(s)

array

Name of the transliterator function for this language.

since	11.1

Type(s)

string

Name of the pluralSuffixesCallback function for this language.

since	11.1

Type(s)

string

Name of the ignoredSearchWordsCallback function for this language.

since	11.1

Type(s)

string

Name of the lowerLimitSearchWordCallback function for this language.

since	11.1

Type(s)

string

Name of the uppperLimitSearchWordCallback function for this language

since	11.1

Type(s)

string

Name of the searchDisplayedCharactersNumberCallback function for this language.

since	11.1

Type(s)

string

An array of error messages or Exception objects.

inherited deprecated

since	11.1
see	\JError
deprecated	12.3 JError has been deprecated

Type(s)

array

JLanguage

Methods

_

Arguments

Response

__construct

Arguments

__toString

Response

_parseLanguageFiles

Arguments

Response

_parseXMLLanguageFile

Arguments

Response

_parseXMLLanguageFiles

Arguments

Response

def

Arguments

Response

exists

Arguments

Response

get

Arguments

Response

getCallerInfo

Response

getDebug

Response

getDefault

Response

getError

Arguments

Response

getErrorFiles

Response

getErrors

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

getPluralSufficesCallback

Response

getPluralSuffixes

Arguments

Response

getPluralSuffixesCallback

Response

getProperties

Arguments