Language

Languages/translation handler class

since

1.0

package

Joomla Framework

Methods

_

Translate function, mimics the php gettext (alias _) function.

_(string string, bool jsSafe = false, bool interpretBackSlashes = true) : string
deprecated

The function checks if $jsSafe is true, then if $interpretBackslashes is true.

see Language::translate()
since

1.0

deprecated

3.0 Use translate instead

Arguments

string

stringThe string to translate

jsSafe

boolMake the result JavaScript safe

interpretBackSlashes

boolInterpret \t and \n

Response

stringThe translation of the string

__construct

Constructor activating the default information of the language.

__construct(\Joomla\Language\ParserRegistry parserRegistry, string path, string lang = '', bool debug = false) : mixed
since

1.0

Arguments

parserRegistry

\Joomla\Language\ParserRegistryA registry containing the supported file parsers

path

stringThe base path to the language folder

lang

stringThe language

debug

boolIndicates if language debugging is enabled

Response

mixed

debugFile

Debugs a language file

debugFile(string filename) : int
since

2.0.0-alpha

Arguments

filename

stringAbsolute path to the file to debug

Response

intA count of the number of parsing errors

exists

Checks if a language exists.

exists(string lang, string basePath = '') : bool
static deprecated

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

see LanguageHelper::exists()
since

1.0

deprecated

3.0 Use LanguageHelper::exists() instead

Arguments

lang

stringLanguage to check.

basePath

stringOptional path to check.

Response

boolTrue if the language exists.

get

Get a metadata language property.

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

1.0

Arguments

property

stringThe name of the property.

default

mixedThe default value.

Response

mixedThe value of the property.

getBasePath

Get the base path for the instance.

getBasePath() : string
since

2.0.0-alpha

Response

string

getCallerInfo

Determine who called Language or Text.

getCallerInfo() : mixed
since

1.0

Response

mixedCaller information or null if unavailable

getCatalogue

Get the message catalogue for the language.

getCatalogue() : \Joomla\Language\MessageCatalogue
since

2.0.0-alpha

Response

\Joomla\Language\MessageCatalogue

getDebug

Get the Debug property.

getDebug() : bool
since

1.0

Response

boolTrue is in debug mode.

getDefault

Get the default language code.

getDefault() : string
since

1.0

Response

stringLanguage code.

getErrorFiles

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

getErrorFiles() : array
since

1.0

Response

array

getFirstDay

Get the first day of the week for this language.

getFirstDay() : int
since

1.0

Response

intThe first day of the week according to the language

getKnownLanguages

Returns a list of known languages for an area

getKnownLanguages(string basePath = '') : array
static deprecated
see LanguageHelper::getKnownLanguages()
since

1.0

deprecated

3.0 Use LanguageHelper::getKnownLanguages() instead

Arguments

basePath

stringThe basepath to use

Response

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

getLanguage

Get the current language code.

getLanguage() : string
since

1.0

Response

stringThe language code

getLanguagePath

Get the path to a language

getLanguagePath(string basePath = '', string language = '') : string
static deprecated
see LanguageHelper::getLanguagePath()
since

1.0

deprecated

3.0 Use LanguageHelper::getLanguagePath() instead

Arguments

basePath

stringThe basepath to use.

language

stringThe language tag.

Response

stringlanguage related path or null.

getLocale

Get the language locale based on current language.

getLocale() : array
since

1.0

Response

arrayThe locale according to the language.

getMetadata

Returns a associative array holding the metadata.

getMetadata(string lang, string basePath) : mixed
static deprecated
see LanguageHelper::getMetadata()
since

1.0

deprecated

3.0 Use LanguageHelper::getMetadata() instead

Arguments

lang

stringThe name of the language.

basePath

stringThe filepath to the language folder.

Response

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

getName

Getter for Name.

getName() : string
since

1.0

Response

stringOfficial name element of the language.

getOrphans

Get the list of orphaned strings if being tracked.

getOrphans() : array
since

1.0

Response

arrayOrphaned text.

getPaths

Get a list of language files that have been loaded.

getPaths(string extension = null) : array
since

1.0

Arguments

extension

stringAn optional extension name.

Response

array

getPluralSuffixes

Returns an array of suffixes for plural rules.

getPluralSuffixes(int count) : string[]
since

1.0

Arguments

count

intThe count number the rule is for.

Response

string[]The array of suffixes.

getTag

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

getTag() : string
since

1.0

Response

stringThe language tag.

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.0

Response

arrayUsed strings.

getWeekEnd

Get the weekends days for this language.

getWeekEnd() : string
since

2.0.0-alpha

Response

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

hasKey

Determines is a key exists.

hasKey(string string) : bool
since

1.0

Arguments

string

stringThe key to check.

Response

boolTrue, if the key exists.

isRtl

Get the RTL property.

isRtl() : bool
since

1.0

Response

boolTrue 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 = '', string lang = null, bool reload = false) : bool
since

1.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.

Response

boolTrue if the file has successfully loaded.

loadLanguage

Loads a language file.

loadLanguage(string filename, string extension = 'unknown') : bool

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

see Language::load()
since

1.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(string filename) : array
since

1.0

Arguments

filename

stringThe name of the file.

Response

arrayThe array of parsed strings.

parseLanguageFiles

Searches for language directories within a certain base dir.

parseLanguageFiles(string dir = null) : array
static deprecated
see LanguageHelper::parseLanguageFiles()
since

1.0

deprecated

3.0 Use LanguageHelper::parseLanguageFiles() instead

Arguments

dir

stringdirectory of files.

Response

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

parseXmlLanguageFile

Parse XML file for language information.

parseXmlLanguageFile(string path) : mixed
static deprecated
see LanguageHelper::parseXMLLanguageFile()
since

1.0

deprecated

3.0 Use LanguageHelper::parseXMLLanguageFile() instead

Arguments

path

stringPath to the XML files.

Response

mixedArray holding the found metadata as a key => value pair or null on an invalid XML file

setCatalogue

Set the message catalogue for the language.

setCatalogue(\Joomla\Language\MessageCatalogue catalogue) : void
since

2.0.0-alpha

Arguments

catalogue

\Joomla\Language\MessageCatalogueThe message catalogue to use.

setDebug

Set the Debug property.

setDebug(bool debug) : bool
since

1.0

Arguments

debug

boolThe debug setting.

Response

boolPrevious value.

setDefault

Set the default language code.

setDefault(string lang) : string
since

1.0

Arguments

lang

stringThe language code.

Response

stringPrevious value.

translate

Translate function, mimics the php gettext (alias _) function.

translate(string string, bool jsSafe = false, bool interpretBackSlashes = true) : string

The function checks if $jsSafe is true, then if $interpretBackslashes is true.

since

2.0.0-alpha

Arguments

string

stringThe string to translate

jsSafe

boolMake the result JavaScript safe

interpretBackSlashes

boolInterpret \t and \n

Response

stringThe translation of the string

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.0

throws

\RuntimeException

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.0

Type(s)

bool

default

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

since

1.0

Type(s)

string

orphans

An array of orphaned text.

since

1.0

Type(s)

array

metadata

Array holding the language metadata.

since

1.0

Type(s)

array

locale

Array holding the language locale or boolean null if none.

since

1.0

Type(s)

array|bool

lang

The language to load.

since

1.0

Type(s)

string

paths

A nested array of language files that have been loaded

since

1.0

Type(s)

array

errorfiles

List of language files that are in error state

since

1.0

Type(s)

array

used

An array of used text, used during debugging.

since

1.0

Type(s)

array

counter

Counter for number of loads.

since

1.0

Type(s)

int

override

An array used to store overrides.

since

1.0

Type(s)

array

localise

The localisation object.

since

2.0.0-alpha

Type(s)

\Joomla\Language\LocaliseInterface

helper

LanguageHelper object

since

2.0.0-alpha

Type(s)

\Joomla\Language\LanguageHelper

basePath

The base path to the language folder

since

2.0.0-alpha

Type(s)

string

catalogue

MessageCatalogue object

since

2.0.0-alpha

Type(s)

\Joomla\Language\MessageCatalogue

parserRegistry

Language parser registry

since

2.0.0-alpha

Type(s)

\Joomla\Language\ParserRegistry