Класс DatabaseSession
DatabaseSession предоставляет методы, используемые с Session.
- Cake\Network\Session\DatabaseSession реализует SessionHandlerInterface
Краткое описание свойств
- Ссылка на таблицу, обрабатывающую данные сессии
$_tableprotected -
$_timeoutprotectedКоличество секунд для обозначения сессии как истекшейinteger
Краткое описание методов
- __construct() public
Конструктор. Просматривает информацию о конфигурации Session и настраивает модель сессии.
- close() publicМетод, вызываемый при закрытии сессии базы данных.
- destroy() publicМетод, вызываемый при уничтожении сессии базы данных.
- gc() publicВспомогательная функция, вызываемая при gc для сессий базы данных.
- open() publicМетод, вызываемый при открытии сессии базы данных.
- read() publicМетод используется для чтения из сессии базы данных.
- setTimeout() publicУстановка значения таймаута для сессий.
- write() publicВспомогательная функция, вызываемая при записи для сессий базы данных.
Подробное описание методов
__construct()source public
__construct( array $config [] )
Конструктор. Просматривает информацию о конфигурации Session и настраивает модель сессии.
Параметры
- массив
$configнеобязательно [] Конфигурация для этого движка. Требуется ключ 'model', соответствующий Таблице для управления сессиями.
close()source public
close( )
Метод, вызываемый при закрытии сессии базы данных.
Возвращает
booleanУспех
Реализация
SessionHandlerInterface::close() destroy()source public
destroy( string|integer $id )
Метод, вызываемый при уничтожении сессии базы данных.
Параметры
- строка|целое число
$id - Идентификатор, уникально определяющий сессию в базе данных.
Возвращает
booleanTrue при успешном удалении, false в противном случае.
Реализация
SessionHandlerInterface::destroy() gc()source public
gc( integer $maxlifetime )
Вспомогательная функция, вызываемая при gc для сессий базы данных.
Параметры
- целое число
$maxlifetime - Сессии, которые не обновлялись в течение последних maxlifetime секунд, будут удалены.
Возвращает
booleanTrue при успехе, false при ошибке.
Реализация
SessionHandlerInterface::gc() open()source public
open( string $savePath , string $name )
Метод, вызываемый при открытии сессии базы данных.
Параметры
- строка
$savePath - Путь для хранения/извлечения сессии.
- строка
$name - Имя сессии.
Возвращает
booleanУспех
Реализация
SessionHandlerInterface::open() read()source public
read( string|integer $id )
Метод используется для чтения из сессии базы данных.
Параметры
- строка|целое число
$id - Идентификатор, уникально определяющий сессию в базе данных.
Возвращает
строкаДанные сессии или пустая строка, если они не существуют.
Реализация
SessionHandlerInterface::read() setTimeout()source public
setTimeout( integer $timeout )
Устанавливает значение таймаута для сессий.
В основном используется в тестировании.
Параметры
- целое число
$timeout - Продолжительность таймаута.
Возвращает
$this
write()source public
write( string|integer $id , mixed $data )
Вспомогательная функция, вызываемая при записи для сессий базы данных.
Параметры
- строка|целое число
$id - Идентификатор, уникально определяющий сессию в базе данных.
- смешанное
$data - Данные, которые необходимо сохранить.
Возвращает
booleanTrue при успешной записи, false в противном случае.
Реализация
SessionHandlerInterface::write() Подробное описание свойств
© 2005–2018 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/3.5/class-Cake.Network.Session.DatabaseSession.html