Класс CacheSession
CacheSession предоставляет методы для сохранения сессий в движке кеша. Используется с Session
- Cake\Network\Session\CacheSession реализует SessionHandlerInterface
См.: \Cake\Model\Datasource\Session для информации о конфигурации.
Расположение: Network/Session/CacheSession.php
Краткое описание свойств
-
$_optionsprotectedПараметры для этого движка сессий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 - Идентификатор, уникально определяющий сессию в кеше
Возвращаемое значение
booleanTrue для успешного удаления, false в противном случае.
Реализация
SessionHandlerInterface::destroy() gc()source public
gc( string $maxlifetime )
Вспомогательная функция, вызываемая при gc для сессий кеша.
Параметры
- строка
$maxlifetime - Сессии, которые не обновлялись в течение последних maxlifetime секунд, будут удалены.
Возвращаемое значение
booleanTrue (независимо от того, успешно ли собрался мусор)
Реализация
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 - Значение данных, подлежащих сохранению.
Возвращаемое значение
booleanTrue для успешной записи, false в противном случае.
Реализация
SessionHandlerInterface::write() Подробное описание свойств
© 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