Spec-Zone.ru › CakePHP 2.9

Класс FlashHelper

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

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

AppHelper
Extended by FlashHelper
Пакет: Cake\Представление\Вспомогательный
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT Лицензия
Расположение: 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'
Ключ [Сообщение.]ключ, который вы отображаете в представлении.
массив $options необязательно массив()

Дополнительные параметры для создания этого сообщения о всплывающей подсказке. Поддерживает ключи 'params' и 'element', используемые в помощнике.

Возвращает

строка|null

Отображенное сообщение о всплывающей подсказке или null, если ключ flash не существует в сессии.


Выбрасывает

UnexpectedValueException
Если значение для ключа настроек flash не является массивом.

© 2005–2016 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.9/class-FlashHelper.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API