Класс FlashMessage

Класс FlashMessage предоставляет способ записи переменной flash в сеанс, чтобы её можно было отобразить в представлении с помощью FlashHelper.

Пространство имён: Cake\Http

Краткое описание свойств

$_config protected

array<string, mixed>

Конфигурация выполнения
$_configInitialized protected

bool

Указывает, была ли конфигурация свойства уже настроена со значениями по умолчанию
$_defaultConfig protected

array<string, mixed>

Конфигурация по умолчанию
$session protected

Cake\Http\Session

Краткое описание методов

__construct() public

Конструктор
_configDelete() protected

Удаляет ключ конфигурации.
_configRead() protected

Читает ключ конфигурации.
_configWrite() protected

Записывает ключ конфигурации.
configShallow() public

Объединяет предоставленную конфигурацию с текущей. В отличие от config(), которая выполняет рекурсивное объединение вложенных ключей, этот метод выполняет простое объединение.
consume() public

Получает сообщения для заданного ключа и удаляет их из сеанса.
error() public

Устанавливает сообщение об ошибке.
getConfig() public

Возвращает конфигурацию.
getConfigOrFail() public

Возвращает конфигурацию для конкретного ключа.
info() public

Устанавливает информационное сообщение.
set() public

Сохраняет сообщения flash, которые можно вывести в представлении.
setConfig() public

Устанавливает конфигурацию.
setExceptionMessage() public

Устанавливает сообщение об исключении в качестве сообщения flash.
success() public

Устанавливает сообщение об успехе.
warning() public

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

Подробное описание методов

__construct() public

__construct(Cake\Http\Session $session, array<string, mixed> $config = [])

Конструктор

Параметры

Cake\Http\Session $session: Экземпляр сессии.
array<string, mixed> $config optional: Массив конфигурации.

См. также

FlashMessage::set() Список допустимых ключей конфигурации.

_configDelete() protected

_configDelete(string $key): void

Удаляет один ключ конфигурации.

Параметры

string $key: Ключ для удаления.

Возвращает

void

Выбрасывает

Cake\Core\Exception\CakeException
если попытка перезаписать существующую конфигурацию

_configRead() protected

_configRead(string|null $key): mixed

Считывает ключ конфигурации.

Параметры

string|null $key: Ключ для чтения.

Возвращает

mixed

_configWrite() protected

_configWrite(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void

Записывает ключ конфигурации.

Параметры

array<string, mixed>|string $key: Ключ для записи.
mixed $value: Значение для записи.
string|bool $merge optional: True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.

Возвращает

void

Выбрасывает

Cake\Core\Exception\CakeException
если попытка перезаписать существующую конфигурацию

configShallow() public

configShallow(array<string, mixed>|string $key, mixed|null $value = null): $this

Сливает предоставленную конфигурацию с существующей. В отличие от config(), которая выполняет рекурсивное слияние для вложенных ключей, этот метод выполняет простое слияние.

Установка конкретного значения:

$this->configShallow('key', $value);

Установка вложенного значения:

$this->configShallow('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->configShallow(['one' => 'value', 'another' => 'value']);

Параметры

array<string, mixed>|string $key: Ключ для установки или полный массив настроек.
mixed|null $value optional: Значение для установки.

Возвращает

$this

consume() public

consume(string $key): array|null

Получить сообщения для данного ключа и удалить их из сессии.

Параметры

string $key: Ключ для получения сообщений.

Возвращает

array|null

error() public

error(string $message, array<string, mixed> $options = []): void

Установить сообщение об ошибке.

Опция 'element' будет установлена в 'error'.

Параметры

string $message: Сообщение для отображения.
array<string, mixed> $options optional: Массив опций.

Возвращает

void

См. также

FlashMessage::set() Список допустимых опций

getConfig() public

getConfig(string|null $key = null, mixed $default = null): mixed

Возвращает конфигурацию.

Использование

Чтение всей конфигурации:

$this->getConfig();

Чтение конкретного значения:

$this->getConfig('key');

Чтение вложенного значения:

$this->getConfig('some.nested.key');

Чтение со значением по умолчанию:

$this->getConfig('some-key', 'default-value');

Параметры

string|null $key optional: Ключ для получения или null для всей конфигурации.
mixed $default optional: Значение по умолчанию, если ключ не найден.

Возвращает

mixed

getConfigOrFail() public

getConfigOrFail(string $key): mixed

Возвращает конфигурацию для указанного ключа.

Значение конфигурации для данного ключа должно существовать, оно никогда не может быть null.

Параметры

string $key: Ключ для получения.

Возвращает

mixed

Выбрасывает

InvalidArgumentException

info() public

info(string $message, array<string, mixed> $options = []): void

Установить информационное сообщение.

Опция 'element' будет установлена в 'info'.

Параметры

string $message: Сообщение для отображения.
array<string, mixed> $options optional: Массив опций.

Возвращает

void

См. также

FlashMessage::set() Список допустимых опций

set() public

set(string $message, array<string, mixed> $options = []): void

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

Если вы вызываете этот метод последовательно, сообщения будут складываться (если они установлены с одним и тем же ключом всплывающего сообщения).

Опции:

key Ключ для установки под ключом сессии Flash.
element Элемент для отображения всплывающего сообщения. Вы можете использовать значение стиля 'SomePlugin.name' для элементов всплывающих сообщений из плагина.
plugin Название плагина для использования элемента.
params Массив переменных, которые будут доступны элементу.
clear Логическое значение, указывающее, нужно ли очистить текущую стопку для начала новой.
escape Установить в false, чтобы шаблоны могли выводить HTML-контент.

Параметры

string $message: Сохраняемое сообщение.
array<string, mixed> $options optional: Массив опций

Возвращает

void

См. также

FlashMessage::$_defaultConfig Значения по умолчанию для опций.

setConfig() public

setConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $this

Устанавливает конфигурацию.

Использование

Установка конкретного значения:

$this->setConfig('key', $value);

Установка вложенного значения:

$this->setConfig('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->setConfig(['one' => 'value', 'another' => 'value']);

Параметры

array<string, mixed>|string $key: Ключ для установки или полный массив настроек.
mixed|null $value optional: Значение для установки.
bool $merge optional: Рекурсивное слияние или перезапись существующей конфигурации, по умолчанию true.

Возвращает

$this

Выбрасывает

Cake\Core\Exception\CakeException
При попытке установить недопустимый ключ.

setExceptionMessage() public

setExceptionMessage(Throwable $exception, array<string, mixed> $options = []): void

Устанавливает сообщение исключения как всплывающее сообщение.

Следующие опции будут установлены по умолчанию, если не заданы:

'element' => 'error',
`params' => ['code' => $exception->getCode()]

Параметры

Throwable $exception: Экземпляр исключения.
array<string, mixed> $options optional: Массив опций.

Возвращает

void

См. также

FlashMessage::set() Список допустимых опций

success() public

success(string $message, array<string, mixed> $options = []): void

Установить сообщение об успехе.

Опция 'element' будет установлена в 'success'.

Параметры

string $message: Сообщение для отображения.
array<string, mixed> $options optional: Массив опций.

Возвращает

void

См. также

FlashMessage::set() Список допустимых опций

warning() public

warning(string $message, array<string, mixed> $options = []): void

Установить сообщение об ошибке.

Опция 'element' будет установлена в 'warning'.

Параметры

string $message: Сообщение для отображения.
array<string, mixed> $options optional: Массив опций.

Возвращаемое значение

void

См. также

FlashMessage::set() Список допустимых опций

Подробное описание свойств

`$_config` protected

Конфигурация во время выполнения

Тип

array<string, mixed>

`$_configInitialized` protected

Указывает, была ли конфигурация свойства уже настроена по умолчанию

Тип

bool

`$_defaultConfig` protected

Конфигурация по умолчанию

Тип

array<string, mixed>

`$session` protected

Тип

Cake\Http\Session

© 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.Http.FlashMessage.html

Класс FlashMessage

Краткое описание свойств

Краткое описание методов

__construct() public

_configDelete() protected

_configRead() protected

_configWrite() protected

configShallow() public

consume() public

error() public

getConfig() public

getConfigOrFail() public

info() public

set() public

setConfig() public

setExceptionMessage() public

success() public

warning() public

Подробное описание методов

__construct() public

Параметры

См. также

_configDelete() protected

Параметры

Возвращает

Выбрасывает

_configRead() protected

Параметры

Возвращает

_configWrite() protected

Параметры

Возвращает

Выбрасывает

configShallow() public

Параметры

Возвращает

consume() public

Параметры

Возвращает

error() public

Параметры

Возвращает

См. также

getConfig() public

Использование

Параметры

Возвращает

getConfigOrFail() public

Параметры

Возвращает

Выбрасывает

info() public

Параметры

Возвращает

См. также

set() public

Опции:

Параметры

Возвращает

См. также

setConfig() public

Использование

Параметры

Возвращает

Выбрасывает

setExceptionMessage() public

Параметры

Возвращает

См. также

success() public

Параметры

Возвращает

См. также

warning() public

Параметры

Возвращаемое значение

См. также

Подробное описание свойств

$_config protected

Тип

`$_config` protected

`$_configInitialized` protected

`$_defaultConfig` protected

`$session` protected