Класс FlashComponent

Компонент FlashComponent CakePHP позволяет записывать переменные всплывающих сообщений в сессию из контроллеров, чтобы их можно было отобразить в представлении с помощью FlashHelper.

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

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

$_componentMap protected

array<string, array>

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

array<string, mixed>

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

bool

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

array<string, mixed>

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

Cake\Controller\ComponentRegistry

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

array

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

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

__call() public

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

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

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

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

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

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

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

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

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

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

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

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

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

Получить обработчики контроллера, которые интересуют этот компонент.
info() public @method

Устанавливает сообщение, используя элемент «информация»
initialize() public

Метод-обработчик инициализации.
log() public

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

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

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

Устанавливает сообщение, используя элемент «успех»
warning() public @method

Устанавливает сообщение, используя элемент «предупреждение»

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

__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<string, mixed> $config = [])

Конструктор

Параметры

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

__debugInfo() public

__debugInfo(): array<string, mixed>

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

Возвращает

array<string, mixed>

__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(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

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

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

$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

error() public @method

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

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

Параметры

string $message
array $options optional

Возвращает

void

flash() protected

flash(): Cake\Http\FlashMessage

Получает экземпляр утилиты сообщений всплывающего окна.

Возвращает

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<string, mixed>

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

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

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

Возвращает

array<string, mixed>

info() public @method

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

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

Параметры

string $message
array $options optional

Возвращает

void

initialize() public

initialize(array<string, mixed> $config): void

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

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

Параметры

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

Возвращает

void

log() public

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

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

Параметры

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

Возвращает

bool

set() public

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

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

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

Параметры:

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

Параметры

Throwable|string $message: Сообщение для отображения. Если это экземпляр \Throwable, будет использовано сообщение исключения, а код будет установлен в параметры.
array<string, mixed> $options optional: Массив параметров

Возвращает

void

setConfig() public

setConfig(array<string, mixed>|string $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']);

Параметры

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

Возвращает

$this

Исключения

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

success() public @method

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

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

Параметры

string $message
array $options optional

Возвращает

void

warning() public @method

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

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

Параметры

string $message
array $options optional

Возвращает

void

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

`$_componentMap` protected

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

Тип

array<string, array>

`$_config` protected

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

Тип

array<string, mixed>

`$_configInitialized` protected

Установлено ли свойство config значениями по умолчанию

Тип

bool

`$_defaultConfig` protected

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

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

Тип

array<string, mixed>

`$_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.3/class-Cake.Controller.Component.FlashComponent.html