Класс DatabaseSession
DatabaseSession предоставляет методы для использования с Session.
Краткое описание свойств
- $_table protected
Cake\ORM\TableСсылка на таблицу, обрабатывающую данные сессии
- $_tableLocator protected
Cake\ORM\Locator\LocatorInterface|nullЭкземпляр локатора таблицы
- $_timeout protected
intКоличество секунд, после которых сессия считается истекшей
Краткое описание методов
-
__construct() public
Конструктор. Изучает конфигурацию сессии и настраивает модель сессии.
-
close() public
Метод, вызываемый при закрытии сессии базы данных.
-
destroy() public
Метод, вызываемый при уничтожении сессии базы данных.
-
gc() public
Вспомогательная функция, вызываемая при GC для сессий базы данных.
-
getTableLocator() public
Получает локатор таблицы.
-
open() public
Метод, вызываемый при открытии сессии базы данных.
-
read() public
Метод для чтения из сессии базы данных.
-
setTableLocator() public
Устанавливает локатор таблицы.
-
setTimeout() public
Устанавливает значение таймаута для сессий.
-
write() public
Вспомогательная функция, вызываемая при записи в сессии базы данных.
Подробное описание методов
__construct() public
__construct(array $config = [])
Конструктор. Изучает конфигурацию сессии и настраивает модель сессии.
Параметры
-
array$config optional Конфигурация для этого движка. Требуется ключ 'model', соответствующий таблице для управления сессиями.
close() public
close(): bool
Метод, вызываемый при закрытии сессии базы данных.
Возвращаемое значение
booldestroy() public
destroy(string $id): bool
Метод, вызываемый при уничтожении сессии базы данных.
Параметры
-
string$id Идентификатор, уникально определяющий сессию в базе данных.
Возвращаемое значение
boolgc() public
gc(int $maxlifetime): bool
Вспомогательная функция, вызываемая при GC для сессий базы данных.
Параметры
-
int$maxlifetime Сессии, которые не обновлялись в течение последних maxlifetime секунд, будут удалены.
Возвращаемое значение
boolgetTableLocator() public
getTableLocator(): Cake\ORM\Locator\LocatorInterface
Получает локатор таблицы.
Возвращаемое значение
Cake\ORM\Locator\LocatorInterfaceopen() public
open(string $savePath, string $name): bool
Метод, вызываемый при открытии сессии базы данных.
Параметры
-
string$savePath Путь для хранения/извлечения сессии.
-
string$name Имя сессии.
Возвращаемое значение
boolread() public
read(string $id): string
Метод для чтения из сессии базы данных.
Параметры
-
string$id Идентификатор, уникально определяющий сессию в базе данных.
Возвращаемое значение
stringsetTableLocator() public
setTableLocator(Cake\ORM\Locator\LocatorInterface $tableLocator): $this
Устанавливает локатор таблицы.
Параметры
-
Cake\ORM\Locator\LocatorInterface$tableLocator Экземпляр LocatorInterface.
Возвращаемое значение
$thissetTimeout() public
setTimeout(int $timeout): $this
Устанавливает значение таймаута для сессий.
В основном используется в тестировании.
Параметры
-
int$timeout Продолжительность таймаута.
Возвращаемое значение
$thiswrite() public
write(string $id, string $data): bool
Вспомогательная функция, вызываемая при записи в сессии базы данных.
Параметры
-
string$id Идентификатор, уникально определяющий сессию в базе данных.
-
string$data Данные для сохранения.
Возвращаемое значение
boolПодробное описание свойств
$_table protected
Ссылка на таблицу, обрабатывающую данные сессии
Тип
Cake\ORM\Table$_tableLocator protected
Экземпляр локатора таблицы
Тип
Cake\ORM\Locator\LocatorInterface|null$_timeout protected
Количество секунд, после которых сессия считается истекшей
Тип
int
© 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/4.2/class-Cake.Http.Session.DatabaseSession.html
