Spec-Zone.ru › CakePHP 3.2

Класс 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
    Метод используется для чтения из сессии базы данных.
  • write() public
    Вспомогательная функция, вызываемая при записи в сессии базы данных.

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

__construct()source public

__construct( array $config [] )

Конструктор. Рассматривает информацию о настройках Session и настраивает модель сессии.

Параметры

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

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

close()source public

close( )

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

Возвращаемое значение

boolean
Успех

Реализация

SessionHandlerInterface::close()

destroy()source public

destroy( 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( integer|string $id )

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

Параметры

целое число/строка $id
Ключ значения для чтения

Возвращаемое значение

строка
Значение ключа или пустая строка, если он не существует

Реализация

SessionHandlerInterface::read()

write()source public

write( integer $id , mixed $data )

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

Параметры

целое число $id
Идентификатор, уникально определяющий сессию в базе данных
смешанное $data
Значение сохраняемых данных.

Возвращаемое значение

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

Реализация

SessionHandlerInterface::write()

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

$_tablesource

protected Cake\ORM\Table

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

$_timeoutsource

protected целое число

Количество секунд, чтобы отметить сессию как просроченную

© 2005–2016 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.
http://api.cakephp.org/3.2/class-Cake.Network.Session.DatabaseSession.html

Spec-Zone.ru

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