MessageCatalogue

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

Конструктор.

Параметры

string	$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

Экземпляр MessageCatalogueInterface

addFallbackCatalogue(MessageCatalogueInterface $catalogue)

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

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

Параметры

MessageCatalogueInterface

$catalogue

Экземпляр MessageCatalogueInterface

MessageCatalogueInterface|null getFallbackCatalogue()

Получает каталог по умолчанию.

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

MessageCatalogueInterface|null

Экземпляр MessageCatalogueInterface или null, если каталог по умолчанию не задан

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	Имя домена