Класс Package
Каталог сообщений
Краткое описание свойств
- $fallback protected
string|nullНазвание пакета по умолчанию для использования, когда ключ сообщения не существует.
- $formatter protected
stringНазвание форматировщика для использования при форматировании переведённых сообщений.
- $messages protected
array<array|string>Ключи сообщений и переводы в этом пакете.
Краткое описание методов
-
__construct() public
Конструктор.
-
addMessage() public
Добавляет одно сообщение для этого пакета.
-
addMessages() public
Добавляет новые сообщения для этого пакета.
-
getFallback() public
Получает имя пакета по умолчанию.
-
getFormatter() public
Получает имя форматировщика для этого пакета.
-
getMessage() public
Получает сообщение с заданным ключом для этого пакета.
-
getMessages() public
Получает сообщения для этого пакета.
-
setFallback() public
Устанавливает имя пакета по умолчанию.
-
setFormatter() public
Устанавливает имя форматировщика для этого пакета.
-
setMessages() public
Устанавливает сообщения для этого пакета.
Подробное описание методов
__construct() public
__construct(string $formatter = 'default', string|null $fallback = null, array<array|string> $messages = [])
Конструктор.
Параметры
-
string$formatter optional Имя форматировщика для использования.
-
string|null$fallback optional Имя пакета по умолчанию для использования.
-
array<array|string>$messages optional Сообщения в этом пакете.
addMessage() public
addMessage(string $key, array|string $message): void
Добавляет одно сообщение для этого пакета.
Параметры
-
string$key ключ сообщения
-
array|string$message само сообщение
Возвращает
voidaddMessages() public
addMessages(array<array|string> $messages): void
Добавляет новые сообщения для этого пакета.
Параметры
-
array<array|string>$messages Сообщения для добавления в этот пакет.
Возвращает
voidgetFallback() public
getFallback(): string|null
Получает имя пакета по умолчанию.
Возвращает
string|nullgetFormatter() public
getFormatter(): string
Получает имя форматировщика для этого пакета.
Возвращает
stringgetMessage() public
getMessage(string $key): array|string|false
Получает сообщение с заданным ключом для этого пакета.
Параметры
-
string$key ключ сообщения для возврата
Возвращает
array|string|falsegetMessages() public
getMessages(): array<array|string>
Получает сообщения для этого пакета.
Возвращает
array<array|string>setFallback() public
setFallback(string|null $fallback): void
Устанавливает имя пакета по умолчанию.
Параметры
-
string|null$fallback Имя пакета по умолчанию.
Возвращает
voidsetFormatter() public
setFormatter(string $formatter): void
Устанавливает имя форматировщика для этого пакета.
Параметры
-
string$formatter Имя форматировщика для этого пакета.
Возвращает
voidsetMessages() public
setMessages(array<array|string> $messages): void
Устанавливает сообщения для этого пакета.
Параметры
-
array<array|string>$messages Сообщения для этого пакета.
Возвращает
voidПодробное описание свойств
$fallback protected
Название пакета по умолчанию для использования, когда ключ сообщения не существует.
Тип
string|null$formatter protected
Имя форматировщика для использования при форматировании переведённых сообщений.
Тип
string$messages protected
Ключи сообщений и переводы в этом пакете.
Тип
array<array|string>
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.3/class-Cake.I18n.Package.html