MessageCatalogue
class MessageCatalogue implements MessageCatalogueInterface, MetadataAwareInterface
Каталог сообщений.
Методы
| __construct(string $locale, array $messages = array()) Конструктор. | ||
| string | getLocale() Возвращает локаль каталога. | |
| array | getDomains() Возвращает домены. | |
| array | all(string $domain = null) Возвращает сообщения в заданном домене. | |
| set(string $id, string $translation, string $domain = 'messages') Устанавливает перевод сообщения. | ||
| bool | has(string $id, string $domain = 'messages') Проверяет, есть ли перевод сообщения. | |
| bool | defines(string $id, string $domain = 'messages') Проверяет, есть ли перевод сообщения (не учитывая механизм fallback). | |
| string | get(string $id, string $domain = 'messages') Возвращает перевод сообщения. | |
| replace(array $messages, string $domain = 'messages') Заменяет переводы для данного домена. | ||
| add(array $messages, string $domain = 'messages') Добавляет переводы для данного домена. | ||
| addCatalogue(MessageCatalogueInterface $catalogue) Объединяет переводы из данного каталога с текущим. | ||
| addFallbackCatalogue(MessageCatalogueInterface $catalogue) Объединяет переводы из данного каталога с текущим только если перевода не существует. | ||
| MessageCatalogueInterface|null | getFallbackCatalogue() Возвращает каталог fallback. | |
| ResourceInterface[] | getResources() Возвращает массив загруженных ресурсов для построения этого набора. | |
| addResource(ResourceInterface $resource) Добавляет ресурс для этого набора. | ||
| mixed | getMetadata(string $key = '', string $domain = 'messages') Возвращает метаданные для заданного домена и ключа. | |
| setMetadata(string $key, mixed $value, string $domain = 'messages') Добавляет метаданные в домен сообщений. | ||
| deleteMetadata(string $key = '', string $domain = 'messages') Удаляет метаданные для заданного ключа и домена. |
Подробности
__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')
Проверяет, существует ли перевод для сообщения (без учета механизма обратной совместимости).
Параметры
| 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 | Имя домена |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.1/Symfony/Component/Translation/MessageCatalogue.html
