Класс DatabaseSession

DatabaseSession предоставляет методы для использования с Session.

Пространство имен: Cake\Http\Session

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

$_table protected

Cake\ORM\Table

Ссылка на таблицу, обрабатывающую данные сессии
$_tableLocator protected

Cake\ORM\Locator\LocatorInterface|null

Экземпляр локатора таблиц
$_timeout protected

int

Количество секунд, после которого сессия считается истекшей
$defaultTable protected

string|null

Псевдоним таблицы по умолчанию для данного объекта.

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

__construct() public

Конструктор. Просматривает информацию о конфигурации сессии и настраивает модель сессии.
close() public

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

Метод, вызываемый при уничтожении сессии базы данных.
fetchTable() public

Удобный метод для получения экземпляра таблицы.
gc() public

Вспомогательная функция, вызываемая при gc для сессий базы данных.
getTableLocator() public

Получает локатор таблиц.
open() public

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

Метод для чтения данных из сессии базы данных.
setTableLocator() public

Устанавливает локатор таблиц.
setTimeout() public

Устанавливает время ожидания для сессий. В основном используется для тестирования.
write() public

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

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

__construct() public

__construct(array<string, mixed> $config = [])

Конструктор. Просматривает информацию о конфигурации сессии и настраивает модель сессии.

Параметры

array<string, mixed> $config optional: Конфигурация для данного движка. Требуется ключ 'model', соответствующий таблице для управления сессиями.

close() public

close(): bool

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

Возвращает

bool

destroy() public

destroy(string $id): bool

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

Параметры

string $id: Идентификатор, уникально определяющий сессию в базе данных.

Возвращает

bool

fetchTable() public

fetchTable(string|null $alias = null, array<string, mixed> $options = []): Cake\ORM\Table

Удобный метод для получения экземпляра таблицы.

Параметры

string|null $alias optional: Имя псевдонима для получения. Должно быть в формате CamelCase. Если null используется значение свойства $defaultTable.
array<string, mixed> $options optional: Опции, с которыми должна быть построена таблица. Если таблица уже загружена, опции реестра будут проигнорированы.

Возвращает

Cake\ORM\Table

Исключение

Cake\Core\Exception\CakeException
Если аргумент `$alias` и свойство `$defaultTable` оба равны `null`.

См. также

\Cake\ORM\TableLocator::get()

gc() public

gc(int $maxlifetime): int|false

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

Параметры

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

Возвращает

int|false

getTableLocator() public

getTableLocator(): Cake\ORM\Locator\LocatorInterface

Получает локатор таблиц.

Возвращает

Cake\ORM\Locator\LocatorInterface

open() public

open(string $path, string $name): bool

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

Параметры

string $path: Путь для хранения/получения сессии.
string $name: Имя сессии.

Возвращает

bool

read() public

read(string $id): string|false

Метод для чтения данных из сессии базы данных.

Параметры

string $id: Идентификатор, уникально определяющий сессию в базе данных.

Возвращает

string|false

setTableLocator() public

setTableLocator(Cake\ORM\Locator\LocatorInterface $tableLocator): $this

Устанавливает локатор таблиц.

Параметры

Cake\ORM\Locator\LocatorInterface $tableLocator: Экземпляр LocatorInterface.

Возвращает

$this

setTimeout() public

setTimeout(int $timeout): $this

Устанавливает время ожидания для сессий. В основном используется для тестирования.

Параметры

int $timeout: Время ожидания.

Возвращает

$this

write() 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

`$defaultTable` protected

Псевдоним таблицы по умолчанию для данного объекта.

Тип

string|null

© 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.3/class-Cake.Http.Session.DatabaseSession.html

Класс DatabaseSession

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

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

__construct() public

close() public

destroy() public

fetchTable() public

gc() public

getTableLocator() public

open() public

read() public

setTableLocator() public

setTimeout() public

write() public

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

__construct() public

Параметры

close() public

Возвращает

destroy() public

Параметры

Возвращает

fetchTable() public

Параметры

Возвращает

Исключение

См. также

gc() public

Параметры

Возвращает

getTableLocator() public

Возвращает

open() public

Параметры

Возвращает

read() public

Параметры

Возвращает

setTableLocator() public

Параметры

Возвращает

setTimeout() public

Параметры

Возвращает

write() public

Параметры

Возвращает

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

$_table protected

Тип

$_tableLocator protected

Тип

$_timeout protected

Тип

$defaultTable protected

Тип

`$_table` protected

`$_tableLocator` protected

`$_timeout` protected

`$defaultTable` protected