Spec-Zone.ru › CakePHP 2.10

Класс SessionHelper

Справочный класс для сессий.

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

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

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

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

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

_render()источник protected

_render( array $flash )

Отображает сообщение об ошибке.

Параметры

массив $flash
Массив с сообщением об ошибке

Возвращает

строка

check()источник public

check( string $name )

Проверяет, установлена ли переменная сессии.

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

Параметры

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

Возвращает

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

Ссылка

https://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();

Возвращает

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

Ссылка

https://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 если параметр не передан

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

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

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

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

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

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

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

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

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

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

Возвращает

строка

Ссылка

https://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
имя ключа сессии, которое вы хотите прочитать

Возвращает

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

Ссылка

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

valid()источник public

valid( )

Проверяет, является ли сессия действительной в представлении

Возвращает

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

Ссылка

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

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

Spec-Zone.ru

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