Класс FlashHelper
Класс FlashHelper для отображения сообщений всплывающего окна.
После установки сообщений в контроллерах с помощью FlashComponent, вы можете использовать этот класс для вывода сообщений всплывающего окна в ваших представлениях.
- AppHelper
-
FlashHelper
Авторские права: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/View/Helper/FlashHelper.php
Краткое описание методов
- render() publicИспользуется для отображения сообщения, установленного в FlashComponent::set()
Подробное описание методов
render()исходный код public
render( string $key 'flash' , array $options array() )
Используется для отображения сообщения, установленного в FlashComponent::set()
В вашем представлении: $this->Flash->render('somekey'); По умолчанию используется flash, если параметр не передан
Вы можете передать дополнительную информацию в генерацию сообщения всплывающего окна. Это позволяет объединить все параметры для определенного типа сообщения всплывающего окна в представлении.
echo $this->Flash->render('flash', array('params' => array('name' => $user['User']['name']))); Это передаст имя текущего пользователя в сообщение всплывающего окна, так что вы сможете создавать персонализированные сообщения без необходимости доступа к этим данным в контроллере.
Наконец, вы можете выбрать элемент, используемый для отображения сообщения всплывающего окна. Использование пользовательских элементов позволяет полностью настроить способ генерации сообщений всплывающего окна.
echo $this->Flash->render('flash', array('element' => 'my_custom_element')); Если вы хотите использовать элемент из плагина для отображения сообщения всплывающего окна, вы можете использовать точечную нотацию для имени элемента плагина:
echo $this->Flash->render('flash', array(
'element' => 'MyPlugin.my_custom_element',
)); Параметры
- строка
$keyнеобязательно 'flash' - Ключ [Сообщение.]key, который вы отображаете в представлении.
- массив
$optionsнеобязательно массив() Дополнительные параметры для создания этого сообщения всплывающего окна. Поддерживает ключи 'params' и 'element', используемые в помощнике.
Возвращаемое значение
string|nullОтображенное сообщение всплывающего окна или null, если ключ flash не существует в сессии.
Исключения
UnexpectedValueExceptionЕсли значение ключа настроек flash не является массивом.
© 2005–2017 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/2.10/class-FlashHelper.html