Класс FlashComponent

Компонент FlashComponent CakePHP предоставляет способ записи переменной flash в сессию из контроллеров для последующего отображения в представлении с помощью FlashHelper.

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

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

$_componentMap protected

array

Таблица поиска компонентов, используемая для ленивой загрузки объектов компонентов.
$_config protected

array

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

bool

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

array

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

Cake\Controller\ComponentRegistry

Класс реестра компонентов, используемый для ленивой загрузки компонентов.
$components protected

array

Другие компоненты, используемые этим компонентом.

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

__call() public

Магический метод для подробных методов flash, основанных на именах элементов.
__construct() public

Конструктор
__debugInfo() public

Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.
__get() public

Магический метод для ленивой загрузки $components.
_configDelete() protected

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

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

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

Метод-прокси для экземпляра FlashMessage.
error() public @method

Устанавливает сообщение, используя элемент "error"
flash() protected

Получить экземпляр утилиты сообщений flash.
getConfig() public

Метод-прокси для экземпляра FlashMessage.
getConfigOrFail() public

Метод-прокси для экземпляра FlashMessage.
getController() public

Получить контроллер, к которому привязан этот компонент.
implementedEvents() public

Получить обратные вызовы контроллера, к которым заинтересован этот компонент.
initialize() public

Метод-обработчик конструктора.
log() public

Метод для удобства записи сообщения в журнал. Для получения дополнительной информации о записи в журналы обратитесь к Log::write().
set() public

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

Метод-прокси для экземпляра FlashMessage.
success() public @method

Устанавливает сообщение, используя элемент "success"

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

__call() public

__call(string $name, array $args): void

Магический метод для подробных методов вспышки на основе имён элементов.

Например: $this->Flash->success('Моё сообщение') будет использовать элемент success.php под templates/element/flash/ для отображения сообщения вспышки.

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

Обратите внимание, что параметр element всегда будет перезаписан. Чтобы вызвать конкретный элемент из плагина, вы должны установить опцию plugin в $args.

Например: $this->Flash->warning('My message', ['plugin' => 'PluginName']) будет использовать элемент warning.php под plugins/PluginName/templates/element/flash/ для отображения сообщения вспышки.

Параметры

string $name: Имя элемента для использования.
array $args: Параметры для передачи при вызове FlashComponent::set().

Возвращает

void

Выбрасывает

Cake\Http\Exception\InternalErrorException
Если сообщение вспышки отсутствует.

__construct() public

__construct(Cake\Controller\ComponentRegistry $registry, array $config = [])

Конструктор

Параметры

Cake\Controller\ComponentRegistry $registry: Регистр компонентов, который этот компонент может использовать для ленивой загрузки своих компонентов.
array $config optional: Массив параметров конфигурации.

__debugInfo() public

__debugInfo(): array

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

Возвращает

array

__get() public

__get(string $name): Cake\Controller\Component|null

Магический метод для ленивой загрузки $components.

Параметры

string $name: Имя компонента для получения.

Возвращает

Cake\Controller\Component|null

_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(string|array $key, mixed $value, bool|string $merge = false): void

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

Параметры

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

Возвращает

void

Выбрасывает

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

configShallow() public

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

Метод-прокси для FlashMessage instance.

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

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

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

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

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

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

Параметры

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

Возвращает

$this

error() public @method

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

Установка сообщения с использованием элемента "error"

Параметры

string $message
array $options optional

Возвращает

void

flash() protected

flash(): Cake\Http\FlashMessage

Получить экземпляр вспомогательной функции flash-сообщений.

Возвращает

Cake\Http\FlashMessage

getConfig() public

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

Метод-прокси для FlashMessage instance.

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

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

$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

Метод-прокси для FlashMessage instance.

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

Параметры

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

Возвращает

mixed

Выбрасывает

InvalidArgumentException

getController() public

getController(): Cake\Controller\Controller

Получить контроллер, к которому привязан этот компонент.

Возвращает

Cake\Controller\Controller

implementedEvents() public

implementedEvents(): array

Получить обратные вызовы контроллера, в которых заинтересован этот компонент.

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

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

Возвращает

array

initialize() public

initialize(array $config): void

Метод-обработчик конструктора.

Реализуйте этот метод, чтобы не переопределять конструктор и вызывать родительский.

Параметры

array $config: Настройки конфигурации, предоставленные этому компоненту.

Возвращает

void

log() public

log(string $message, int|string $level = LogLevel::ERROR, string|array $context = []): bool

Удобный метод для записи сообщения в журнал. См. Log::write() для получения дополнительной информации о записи в журналы.

Параметры

string $message: Сообщение журнала.
int|string $level optional: Уровень ошибки.
string|array $context optional: Дополнительные данные журнала, относящиеся к этому сообщению.

Возвращает

bool

set() public

set(stringThrowable $message, array $options = []): void

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

В вашем контроллере: $this->Flash->set('Это было сохранено');

Опции:

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

Параметры

stringThrowable $message: Сообщение для вспышки. Если это экземпляр \Throwable, будет использовано сообщение исключения, а код будет установлен в params.
array $options optional: Массив опций

Возвращает

void

setConfig() public

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

Метод-прокси для экземпляра FlashMessage.

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

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

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

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

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

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

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

Параметры

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

Возвращает

$this

Исключения

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

success() public @method

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

Установка сообщения с использованием элемента "success".

Параметры

string $message
array $options необязательно

Возвращает

void

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

`$_componentMap` protected

Таблица поиска компонентов, используемая для отложенной загрузки объектов компонентов.

Тип

array

`$_config` protected

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

Тип

array

`$_configInitialized` protected

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

Тип

bool

`$_defaultConfig` protected

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

Эти значения сливаются с конфигурацией, предоставляемой пользователем, когда компонент используется.

Тип

array

`$_registry` protected

Класс реестра компонентов, используемый для отложенной загрузки компонентов.

Тип

Cake\Controller\ComponentRegistry

`$components` protected

Другие компоненты, используемые этим компонентом.

Тип

array

© 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.2/class-Cake.Controller.Component.FlashComponent.html