Класс DatabaseSession

__construct()source public

__construct( array $config = [] )

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

Параметры

массив $config необязательно []

Конфигурация для этого движка. Требуется ключ 'model', соответствующий таблице для управления сессиями.

close()source public

close( )

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

Возвращает

boolean
Успех

Реализация

SessionHandlerInterface::close()

destroy()source public

destroy( string|integer $id )

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

Параметры

строка или целое число $id

Идентификатор, однозначно определяющий сессию в базе данных.

Возвращает

boolean
True для успешного удаления, false в противном случае.

Реализация

SessionHandlerInterface::destroy()

gc()source public

gc( integer $maxlifetime )

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

Параметры

целое число $maxlifetime

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

Возвращает

boolean
True при успехе, 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

Данные, которые необходимо сохранить.

Возвращает

boolean
True для успешной записи, false в противном случае.

Реализация

SessionHandlerInterface::write()

getTableLocator()source public

getTableLocator( )

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

Возвращает

Cake\ORM\Locator\LocatorInterface

setTableLocator()source public

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

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

Параметры

Cake\ORM\Locator\LocatorInterface $tableLocator

Экземпляр LocatorInterface.

Возвращает

$this

tableLocator()source public deprecated

tableLocator( Cake\ORM\Locator\LocatorInterface $tableLocator = null )

Установка локатора таблицы. Если параметры не переданы, возвращает текущий используемый локатор.

Устарело

3.5.0 Используйте getTableLocator()/setTableLocator() вместо этого.

Параметры

Cake\ORM\Locator\LocatorInterface $tableLocator необязательно null

Экземпляр LocatorInterface.

Возвращает

Cake\ORM\Locator\LocatorInterface