Spec-Zone.ru › CakePHP 3.2

Класс CacheSession

CacheSession предоставляет методы для сохранения сессий в движке кеша. Используется с Session

Cake\Network\Session\CacheSession реализует SessionHandlerInterface
Пространство имён: Cake\Network\Session
См.: \Cake\Model\Datasource\Session для информации о конфигурации.
Расположение: Network/Session/CacheSession.php

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

  • $_options protected
    array
    Параметры для этого движка сессий

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

  • __construct() public
    Конструктор.
  • close() public
    Метод, вызываемый при закрытии сессии базы данных.
  • destroy() public
    Метод, вызываемый при уничтожении сессии кеша.
  • gc() public
    Вспомогательная функция, вызываемая при gc для сессий кеша.
  • open() public
    Метод, вызываемый при открытии сессии базы данных.
  • read() public
    Метод для чтения из сессии кеша.
  • write() public
    Вспомогательная функция, вызываемая при записи в сессии кеша.

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

__construct()source public

__construct( array $config [] )

Конструктор.

Параметры

массив $config необязательно []

Конфигурация, используемая для этого движка. Требуется ключ 'config', представляющий имя конфигурации Cache, используемой для хранения сессии

Исключения

InvalidArgumentException
если ключ 'config' не указан

close()source public

close( )

Метод, вызываемый при закрытии сессии базы данных.

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

boolean
Успех

Реализация

SessionHandlerInterface::close()

destroy()source public

destroy( integer $id )

Метод, вызываемый при уничтожении сессии кеша.

Параметры

целое число $id
Идентификатор, уникально определяющий сессию в кеше

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

boolean
True для успешного удаления, false в противном случае.

Реализация

SessionHandlerInterface::destroy()

gc()source public

gc( string $maxlifetime )

Вспомогательная функция, вызываемая при gc для сессий кеша.

Параметры

строка $maxlifetime
Сессии, которые не обновлялись в течение последних maxlifetime секунд, будут удалены.

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

boolean
True (независимо от того, успешно ли собрался мусор)

Реализация

SessionHandlerInterface::gc()

open()source public

open( string $savePath , string $name )

Метод, вызываемый при открытии сессии базы данных.

Параметры

строка $savePath
Путь для хранения/извлечения сессии.
строка $name
Имя сессии.

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

boolean
Успех

Реализация

SessionHandlerInterface::open()

read()source public

read( string $id )

Метод для чтения из сессии кеша.

Параметры

строка $id
Ключ значения для чтения

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

строка
Значение ключа или пустая строка, если ключ не существует

Реализация

SessionHandlerInterface::read()

write()source public

write( integer $id , mixed $data )

Вспомогательная функция, вызываемая при записи в сессии кеша.

Параметры

целое число $id
Идентификатор, уникально определяющий сессию в базе данных
смешанный $data
Значение данных, подлежащих сохранению.

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

boolean
True для успешной записи, false в противном случае.

Реализация

SessionHandlerInterface::write()

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

$_optionssource

protected массив

Параметры для этого движка сессий

[]

© 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.
http://api.cakephp.org/3.2/class-Cake.Network.Session.CacheSession.html

Spec-Zone.ru

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