Класс 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