Класс FlashHelper

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

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

Пространство имен: Cake\View\Helper

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

$_View protected

Cake\View\View

Экземпляр View, к которому прикреплен этот помощник
$_config protected

array<string, mixed>

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

bool

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

array<string, mixed>

Конфигурация по умолчанию для этого помощника.
$_helperMap protected

array<string, array>

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

array

Список помощников, используемых этим помощником

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

__call() public

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

Конструктор по умолчанию
__debugInfo() public

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

Лениво загружает помощников.
_configDelete() protected

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

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

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

Возвращает строку, которая будет использоваться в качестве обработчика onclick для диалогов подтверждения.
addClass() public

Добавляет указанный класс к параметрам элемента
configShallow() public

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

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

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

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

Обработчики событий.
initialize() public

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

Используется для отрисовки сообщения, заданного в FlashComponent::set()
setConfig() public

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

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

__call() public

__call(string $method, array $params): mixed|void

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

Параметры

string $method: Метод для вызова
array $params: Массив параметров для метода.

Возвращает

mixed|void

__construct() public

__construct(Cake\View\View $view, array<string, mixed> $config = [])

Конструктор по умолчанию

Параметры

Cake\View\View $view: Представление, к которому привязан данный помощник.
array<string, mixed> $config необязательно: Настройки конфигурации для помощника.

__debugInfo() public

__debugInfo(): array<string, mixed>

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

Возвращает

array<string, mixed>

__get() public

__get(string $name): Cake\View\Helper|null|void

Ленично загружает помощников.

Параметры

string $name: Имя свойства, к которому осуществляется доступ.

Возвращает

Cake\View\Helper|null|void

_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 необязательно: Истина для рекурсивного слияния, 'shallow' для простого слияния, ложь для перезаписи, по умолчанию ложь.

Возвращает

void

Выбрасывает

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

_confirm() protected

_confirm(string $okCode, string $cancelCode): string

Возвращает строку, которая должна использоваться в качестве обработчика onclick для диалогов подтверждения.

Параметры

string $okCode: Код, который будет выполнен после выбора пользователем 'ОК'
string $cancelCode: Код, который будет выполнен после выбора пользователем 'Отмена'

Возвращает

string

addClass() public

addClass(array<string, mixed> $options, string $class, string $key = 'class'): array<string, mixed>

Добавляет заданный класс к параметрам элемента.

Параметры

array<string, mixed> $options: Массив параметров/атрибутов для добавления класса.
string $class: Имя добавляемого класса.
string $key необязательно: Ключ для использования для класса. По умолчанию 'class'.

Возвращает

array<string, mixed>

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 необязательно: Значение для установки.

Возвращает

$this

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 необязательно: Ключ для получения или null для всей конфигурации.
mixed $default необязательно: Возвращаемое значение, когда ключ не существует.

Возвращает

mixed

getConfigOrFail() public

getConfigOrFail(string $key): mixed

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

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

Параметры

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

Возвращает

mixed

Выбрасывает

InvalidArgumentException

getView() public

getView(): Cake\View\View

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

Возвращает

Cake\View\View

implementedEvents() public

implementedEvents(): array<string, mixed>

Обработчики событий.

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

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

Возвращает

array<string, mixed>

initialize() public

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

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

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

Параметры

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

Возвращает

void

render() public

render(string $key = 'flash', array<string, mixed> $options = []): string|null

Используется для отображения сообщения, заданного в FlashComponent::set()

В вашем файле шаблона: $this->Flash->render('somekey'); Будет по умолчанию flash, если параметр не передан

Вы можете передавать дополнительную информацию в генерацию сообщений flash. Это позволяет объединить все параметры для данного типа сообщений flash в представление.

echo $this->Flash->render('flash', ['params' => ['name' => $user['User']['name']]]);

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

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

echo $this->Flash->render('flash', ['element' => 'my_custom_element']);

Если вы хотите использовать элемент из плагина для отображения сообщения flash, вы можете использовать точечную нотацию для имени элемента плагина:

echo $this->Flash->render('flash', [
  'element' => 'MyPlugin.my_custom_element',
]);

Если в сессии хранится несколько сообщений, каждое сообщение будет отображаться в собственном элементе.

Параметры

string $key необязательно: Вы отображаете [Flash.]key в представлении.
array<string, mixed> $options необязательно: Дополнительные параметры для создания этого сообщения flash. Поддерживает ключи 'params' и 'element', используемые в помощнике.

Возвращает

string|null

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 необязательно: Значение для установки.
bool $merge необязательно: Выполнять рекурсивное слияние или перезапись существующей конфигурации, по умолчанию — true.

Возвращает

$this

Выбрасывает

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

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

`$_View` protected

Экземпляр объекта View, к которому прикреплён этот помощник

Тип

Cake\View\View

`$_config` protected

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

Тип

array<string, mixed>

`$_configInitialized` protected

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

Тип

bool

`$_defaultConfig` protected

Конфигурация по умолчанию для этого помощника.

Тип

array<string, mixed>

`$_helperMap` protected

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

Тип

array<string, array>

`$helpers` 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.View.Helper.FlashHelper.html

Класс FlashHelper

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

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

__call() public

__construct() public

__debugInfo() public

__get() public

_configDelete() protected

_configRead() protected

_configWrite() protected

_confirm() protected

addClass() public

configShallow() public

getConfig() public

getConfigOrFail() public

getView() public

implementedEvents() public

initialize() public

render() public

setConfig() public

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

__call() public

Параметры

Возвращает

__construct() public

Параметры

__debugInfo() public

Возвращает

__get() public

Параметры

Возвращает

_configDelete() protected

Параметры

Возвращает

Выбрасывает

_configRead() protected

Параметры

Возвращает

_configWrite() protected

Параметры

Возвращает

Выбрасывает

_confirm() protected

Параметры

Возвращает

addClass() public

Параметры

Возвращает

configShallow() public

Параметры

Возвращает

getConfig() public

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

Параметры

Возвращает

getConfigOrFail() public

Параметры

Возвращает

Выбрасывает

getView() public

Возвращает

implementedEvents() public

Возвращает

initialize() public

Параметры

Возвращает

render() public

Параметры

Возвращает

setConfig() public

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

Параметры

Возвращает

Выбрасывает

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

$_View protected

Тип

$_config protected

Тип

$_configInitialized protected

`$_View` protected

`$_config` protected

`$_configInitialized` protected

`$_defaultConfig` protected

`$_helperMap` protected

`$helpers` protected