Loc
FinalYes
Table of Contents
Methods
- getCurrentLang() : string
- getDefaultLang() : string
- Returns default language for specified language. Default language is used when translation is not found.
- getIncludedFiles() : array<string|int, mixed>
- Returns previously included lang files.
- getMessage() : string|null
- Returns translation by message code.
- getMessagePlural() : string|null
- Returns plural message by message code and number.
- getPluralForm() : int
- Return language plural form id by number see http://docs.translatehouse.org/projects/localization-guide/en/latest/l10n/pluralforms.html
- loadCustomMessages() : mixed
- Loads custom messages from the file to overwrite messages by their IDs.
- loadLanguageFile() : array<string|int, mixed>
- Loads language messages for specified file
- loadMessages() : mixed
- Loads language messages for specified file in a lazy way
- setCurrentLang() : mixed
Methods
getCurrentLang()
public
static getCurrentLang() : string
Return values
stringgetDefaultLang()
Returns default language for specified language. Default language is used when translation is not found.
public
static getDefaultLang(string $lang) : string
Parameters
- $lang : string
Return values
stringgetIncludedFiles()
Returns previously included lang files.
public
static getIncludedFiles() : array<string|int, mixed>
Return values
array<string|int, mixed>getMessage()
Returns translation by message code.
public
static getMessage(string $code[, array<string|int, mixed> $replace = null ][, string $language = null ]) : string|null
Loc::loadMessages(FILE) should be called first once per php file
Parameters
- $code : string
- $replace : array<string|int, mixed> = null
-
e.g. array("#NUM#"=>5)
- $language : string = null
Return values
string|nullgetMessagePlural()
Returns plural message by message code and number.
public
static getMessagePlural(string $code, int $value[, array<string|int, mixed>|null $replace = null ][, string|null $language = null ]) : string|null
Loc::loadMessages(FILE) should be called first once per php file
Parameters
- $code : string
- $value : int
- $replace : array<string|int, mixed>|null = null
-
e.g. array("#NUM#"=>5)
- $language : string|null = null
Return values
string|nullgetPluralForm()
Return language plural form id by number see http://docs.translatehouse.org/projects/localization-guide/en/latest/l10n/pluralforms.html
public
static getPluralForm(mixed $value[, mixed $language = '' ]) : int
Parameters
- $value : mixed
- $language : mixed = ''
Return values
intloadCustomMessages()
Loads custom messages from the file to overwrite messages by their IDs.
public
static loadCustomMessages(string $file[, string|null $language = null ]) : mixed
Parameters
- $file : string
- $language : string|null = null
loadLanguageFile()
Loads language messages for specified file
public
static loadLanguageFile(string $file[, string $language = null ][, bool $normalize = true ]) : array<string|int, mixed>
Parameters
- $file : string
- $language : string = null
- $normalize : bool = true
Return values
array<string|int, mixed>loadMessages()
Loads language messages for specified file in a lazy way
public
static loadMessages(string $file) : mixed
Parameters
- $file : string
setCurrentLang()
public
static setCurrentLang(mixed $language) : mixed
Parameters
- $language : mixed