MessageCatalogue

__construct(string|null $locale, array $messages = array())

Параметры

string|null	$locale	Язык
array	$messages	Массив сообщений, классифицированных по домену

string getLocale()

Получает язык каталога.

Значение возврата

string

Язык

array getDomains()

Получает домены.

Значение возврата

array

Массив доменов

array all(string $domain = null)

Получает сообщения в заданном домене.

Если $domain равен null, возвращает все сообщения.

Параметры

string

$domain

Имя домена

Значение возврата

array

Массив сообщений

set(string $id, string $translation, string $domain = 'messages')

Устанавливает перевод сообщения.

Параметры

string	$id	Идентификатор сообщения
string	$translation	Перевод сообщения
string	$domain	Имя домена

bool has(string $id, string $domain = 'messages')

Проверяет, есть ли перевод для сообщения.

Параметры

string	$id	Идентификатор сообщения
string	$domain	Имя домена

Значение возврата

bool	true, если сообщение имеет перевод; иначе false

bool defines(string $id, string $domain = 'messages')

Проверяет наличие перевода сообщения (не учитывая механизм fallback).

Параметры

string	$id	Идентификатор сообщения
string	$domain	Имя домена

Значение возврата

bool	true, если сообщение имеет перевод; иначе false

string get(string $id, string $domain = 'messages')

Получает перевод сообщения.

Параметры

string	$id	Идентификатор сообщения
string	$domain	Имя домена

Значение возврата

string

Перевод сообщения

replace(array $messages, string $domain = 'messages')

Устанавливает переводы для заданного домена.

Параметры

array	$messages	Массив переводов
string	$domain	Имя домена

add(array $messages, string $domain = 'messages')

Добавляет переводы для заданного домена.

Параметры

array	$messages	Массив переводов
string	$domain	Имя домена

addCatalogue(MessageCatalogueInterface $catalogue)

Объединяет переводы из данного каталога с текущим.

Два каталога должны иметь одинаковый язык.

Параметры

MessageCatalogueInterface

$catalogue

addFallbackCatalogue(MessageCatalogueInterface $catalogue)

Объединяет переводы из данного каталога с текущим только при отсутствии перевода.

Используется для предоставления стандартных переводов, если они отсутствуют для текущего языка.

Параметры

MessageCatalogueInterface

$catalogue

MessageCatalogueInterface|null getFallbackCatalogue()

Получает каталог fallback.

Значение возврата

MessageCatalogueInterface|null

Экземпляр MessageCatalogueInterface или null, если fallback не задан

ResourceInterface[] getResources()

Возвращает массив загруженных ресурсов для построения этой коллекции.

Значение возврата

ResourceInterface[]

Массив ресурсов

addResource(ResourceInterface $resource)

Добавляет ресурс для этой коллекции.

Параметры

ResourceInterface

$resource

mixed getMetadata(string $key = '', string $domain = 'messages')

Получает метаданные для заданного домена и ключа.

Передача пустого домена вернёт массив со всеми метаданными, индексированными по домену, а затем по ключу. Передача пустого ключа вернёт массив со всеми метаданными для заданного домена.

Параметры

string	$key	Ключ
string	$domain	Имя домена

Значение возврата

mixed

Установленное значение или массив с домена/ключами или null

setMetadata(string $key, mixed $value, string $domain = 'messages')

Добавляет метаданные в домен сообщений.

Параметры

string	$key	Ключ
mixed	$value	Значение
string	$domain	Имя домена

deleteMetadata(string $key = '', string $domain = 'messages')

Удаляет метаданные для заданного ключа и домена.

Передача пустого домена удалит все метаданные. Передача пустого ключа удалит все метаданные для заданного домена.

Параметры

string	$key	Ключ
string	$domain	Имя домена