Класс DatabaseSession
DatabaseSession предоставляет методы для использования с Session.
- Cake\Http\Session\DatabaseSession реализует SessionHandlerInterface использует Cake\ORM\Locator\LocatorAwareTrait
Краткое описание свойств
- Ссылка на таблицу, обрабатывающую данные сеанса
$_tableprotected -
$_timeoutprotectedКоличество секунд для обозначения сеанса как истекшегоinteger
Унаследованные свойства
Краткое описание методов
- __construct() public
Конструктор. Просматривает информацию о конфигурации сеанса и настраивает модель сеанса.
- close() publicМетод, вызываемый при закрытии сеанса базы данных.
- destroy() publicМетод, вызываемый при уничтожении сеанса базы данных.
- gc() publicВспомогательная функция, вызываемая при gc для сеансов базы данных.
- open() publicМетод, вызываемый при открытии сеанса базы данных.
- read() publicМетод, используемый для чтения из сеанса базы данных.
- setTimeout() publicУстановить значение таймаута для сеансов.
- write() publicВспомогательная функция, вызываемая при записи для сеансов базы данных.
Подробное описание методов
__construct()source public
__construct( array $config = [] )
Конструктор. Просматривает информацию о конфигурации сеанса и настраивает модель сеанса.
Параметры
- массив
$configнеобязательно [] Конфигурация для этого движка. Требуется ключ 'model', соответствующий таблице для управления сеансами.
close()source public
close( )
Метод, вызываемый при закрытии сеанса базы данных.
Возвращает
booleanУспех
Реализация
SessionHandlerInterface::close() destroy()source public
destroy( string|integer $id )
Метод, вызываемый при уничтожении сеанса базы данных.
Параметры
- строка|целое число
$id - Идентификатор, уникально определяющий сеанс в базе данных.
Возвращает
booleanИстина для успешного удаления, ложь в противном случае.
Реализация
SessionHandlerInterface::destroy() gc()source public
gc( integer $maxlifetime )
Вспомогательная функция, вызываемая при gc для сеансов базы данных.
Параметры
- целое число
$maxlifetime - Сеансы, которые не обновлялись в течение последних maxlifetime секунд, будут удалены.
Возвращает
booleanИстина при успехе, ложь при неудаче.
Реализация
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 - Данные для сохранения.
Возвращает
booleanИстина для успешной записи, ложь в противном случае.
Реализация
SessionHandlerInterface::write() Методы, используемые из Cake\ORM\Locator\LocatorAwareTrait
getTableLocator()source public
getTableLocator( )
Получить локатор таблицы.
Возвращает
Cake\ORM\Locator\LocatorInterfacesetTableLocator()source public
setTableLocator( Cake\ORM\Locator\LocatorInterface $tableLocator )
Установить локатор таблицы.
Параметры
-
Cake\ORM\Locator\LocatorInterface$tableLocator - Экземпляр LocatorInterface.
Возвращает
$this
tableLocator()source public устаревший
tableLocator( Cake\ORM\Locator\LocatorInterface $tableLocator = null )
Устанавливает локатор таблицы. Если параметры не переданы, он вернёт текущий используемый локатор.
Устарело
3.5.0 Используйте getTableLocator()/setTableLocator() вместо этого.Параметры
-
Cake\ORM\Locator\LocatorInterface$tableLocatorнеобязательно null - Экземпляр LocatorInterface.
Возвращает
Cake\ORM\Locator\LocatorInterfaceПодробное описание свойств
© 2005–present 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.7/class-Cake.Http.Session.DatabaseSession.html