Spec-Zone.ru › CakePHP 3.4

Класс DatabaseSession

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

Cake\Network\Session\DatabaseSession реализует SessionHandlerInterface
Пространство имён: Cake\Network\Session
Расположение: Network/Session/DatabaseSession.php

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

  • $_table protected
    Cake\ORM\Table
    Ссылка на таблицу, обрабатывающую данные сеанса
  • $_timeout protected
    integer
    Количество секунд для обозначения сеанса как истекшего

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

  • __construct() public

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

  • close() public
    Метод, вызываемый при закрытии сеанса базы данных.
  • destroy() public
    Метод, вызываемый при уничтожении сеанса базы данных.
  • gc() public
    Вспомогательная функция, вызываемая для gc сеансов базы данных.
  • open() public
    Метод, вызываемый при открытии сеанса базы данных.
  • read() public
    Метод для чтения данных из сеанса базы данных.
  • setTimeout() public
    Установить время ожидания для сеансов.
  • write() public
    Вспомогательная функция, вызываемая при записи для сеансов базы данных.

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

__construct()source public

__construct( array $config [] )

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

Параметры

массив $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( string $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()

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

$_tablesource

protected Cake\ORM\Table

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

$_timeoutsource

protected целое число

Количество секунд для обозначения сеанса как истекшего

© 2005–2017 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.4/class-Cake.Network.Session.DatabaseSession.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API