Spec-Zone.ru › CakePHP 2.9

Класс SessionHelper

Справочник по сеансам.

Чтение сеансов из представления.

AppHelper
Extended by SessionHelper
Пакет: Cake\Представление\Помощник
Ссылка: http://book.cakephp.org/2.0/ru/core-libraries/helpers/session.html
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: Лицензия MIT
Расположение: Cake/View/Helper/SessionHelper.php

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

  • check() public
    Проверяет, установлено ли значение ключа сессии.
  • consume() public
    Считывает и удаляет значение сессии по ключу.
  • error() public
    Возвращает последнюю ошибку, возникшую в сессии
  • flash() public
    Используется для отображения сообщения, установленного в Controller::Session::setFlash()
  • read() public
    Считывает значение сессии по ключу или возвращает значения для всех ключей.
  • valid() public
    Используется для проверки валидности сессии в представлении

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

check()исходный код public

check( string $name )

Проверяет, установлено ли значение ключа сессии.

В вашем представлении: $this->Session->check('Controller.sessKey');

Параметры

строка $name
Ключ сессии для проверки.

Возвращаемое значение

логическое значение

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/session.html#SessionHelper::check

consume()исходный код public

consume( string $name )

Считывает и удаляет значение сессии по ключу.

В вашем представлении: $this->Session->consume('Controller.sessKey');

Параметры

строка $name
имя ключа сессии, которое вы хотите считать

Возвращаемое значение

смешанное
значения из переменных сессии

error()исходный код public

error( )

Возвращает последнюю ошибку, возникшую в сессии

В вашем представлении: $this->Session->error();

Возвращаемое значение

строка
последняя ошибка

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/session.html#displaying-notifications-or-flash-messages

flash()исходный код public

flash( string $key 'flash' , array $attrs array() )

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

В вашем представлении: $this->Session->flash('somekey'); Используется flash по умолчанию, если параметр не передан

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

echo $this->Session->flash('flash', array('params' => array('class' => 'new-flash')));

Вышеприведенное сгенерирует сообщение всплывающей подсказки с пользовательским именем класса. Используя $attrs['params'] можно передавать дополнительные данные в рендеринг элемента, которые будут доступны как локальные переменные при рендеринге элемента:

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

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

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

echo $this->Session->flash('flash', array('element' => 'my_custom_element'));

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

echo $this->Session->flash('flash', array(
    'element' => 'my_custom_element',
    'params' => array('plugin' => 'my_plugin')
));

Устаревший

3.0.0 С версии 2.7 используйте FlashHelper::render() вместо этого.

Параметры

строка $key необязательно 'flash'
Ключ сообщения, который вы отображаете в представлении.
массив $attrs необязательно array()

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

Возвращаемое значение

строка

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/session.html#SessionHelper::flash

read()исходный код public

read( string $name null )

Считывает значение сессии по ключу или возвращает значения для всех ключей.

В вашем представлении: $this->Session->read('Controller.sessKey'); Вызов метода без параметра вернет все переменные сессии

Параметры

строка $name необязательно null
имя ключа сессии, которое вы хотите считать

Возвращаемое значение

смешанное
значения из переменных сессии

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/session.html#SessionHelper::read

valid()исходный код public

valid( )

Используется для проверки валидности сессии в представлении

Возвращаемое значение

логическое значение

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/session.html#SessionHelper::valid

© 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-SessionHelper.html

Spec-Zone.ru

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