Documentation

Translator
in package
implements ITranslator

Class Translator

Tags
subpackage

Models

Interfaces, Classes and Traits

ITranslator

Table of Contents

DEFAULT_LANGUAGE  = 'en'
DEFAULT_LANGUAGE_CODE  = 'en_US'
DEFAULT_LANGUAGE_TITLE  = 'English'
$cookieLang  : string
$detectLang  : string
$domains  : array<string|int, mixed>
$languages  : array<string|int, mixed>
$translations  : Translations
__construct()  : mixed
Translator constructor.
detectLanguageId()  : string
Определить идентификатор языка
getCurrentLanguage()  : mixed
getLanguageCodes()  : array<string|int, int>|array<string|int, string>
Возвращает коды языков
getLanguages()  : array<string|int, mixed>
Возвращает массив доступных языков
setCookieLang()  : void
setDetectLang()  : void
Устанавливает выбраный язык
setLanguage()  : void
Устанавливает язык
translate()  : string
Переводит текст
getDefaultLanguage()  : array<string|int, array<string|int, string>>
Возвращает массив с параметрами языка выбраного по умолчанию
loadTranslates()  : mixed
Загружает переводы
preparePaths()  : array<string|int, mixed>
Формирует массив путей до директорий модулей в которых находятся переводы

Constants

DEFAULT_LANGUAGE

public string DEFAULT_LANGUAGE = 'en'

DEFAULT_LANGUAGE_CODE

public string DEFAULT_LANGUAGE_CODE = 'en_US'

DEFAULT_LANGUAGE_TITLE

public string DEFAULT_LANGUAGE_TITLE = 'English'

Properties

$domains

private array<string|int, mixed> $domains = []

$languages

private array<string|int, mixed> $languages = []

$translations

private Translations $translations

Methods

__construct()

Translator constructor.

public __construct(array<string|int, mixed> $languages, string $projectDir) : mixed
Parameters
$languages : array<string|int, mixed>
$projectDir : string
Return values
mixed

detectLanguageId()

Определить идентификатор языка

public detectLanguageId() : string
Return values
string

getCurrentLanguage()

public getCurrentLanguage() : mixed
Return values
mixed

getLanguageCodes()

Возвращает коды языков

public getLanguageCodes() : array<string|int, int>|array<string|int, string>
Return values
array<string|int, int>|array<string|int, string>

getLanguages()

Возвращает массив доступных языков

public getLanguages() : array<string|int, mixed>
Return values
array<string|int, mixed>

setCookieLang()

public setCookieLang(string|null $cookieLang) : void
Parameters
$cookieLang : string|null
Return values
void

setDetectLang()

Устанавливает выбраный язык

public setDetectLang(string $detectLang) : void
Parameters
$detectLang : string
Return values
void

setLanguage()

Устанавливает язык

public setLanguage([string|null $langId = null ]) : void
Parameters
$langId : string|null = null
Return values
void

translate()

Переводит текст

public translate(mixed $message, mixed ...$parameters) : string
Parameters
$message : mixed
$parameters : mixed
Return values
string

getDefaultLanguage()

Возвращает массив с параметрами языка выбраного по умолчанию

private getDefaultLanguage() : array<string|int, array<string|int, string>>
Return values
array<string|int, array<string|int, string>>

loadTranslates()

Загружает переводы

private loadTranslates(string $code) : mixed
Parameters
$code : string

код языка

Return values
mixed

preparePaths()

Формирует массив путей до директорий модулей в которых находятся переводы

private preparePaths(string $projectDir) : array<string|int, mixed>
Parameters
$projectDir : string

путь до корневой директории

Return values
array<string|int, mixed>

['moduleName'=>'/languages']

Search results