Spec-Zone.ru › CakePHP 3.8

Класс CacheSession

CacheSession предоставляет методы для сохранения сессий в движке кэша. Используется с Session

Cake\Http\Session\CacheSession реализует SessionHandlerInterface
Пространство имен: Cake\Http\Session
См.: \Cake\Model\Datasource\Session для информации о конфигурации.
Расположение: Http/Session/CacheSession.php

Резюме свойств

  • $_options protected
    array
    Параметры для этого движка сессий

Резюме методов

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

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

__construct()source public

__construct( array $config = [] )

Конструктор.

Параметры

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

Конфигурация для использования этим движком. Требуется ключ 'config', который является именем конфигурации кэша для хранения сессии

Исключения

InvalidArgumentException
если ключ 'config' не указан

close()source public

close( )

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

Возвращает

boolean
Успех

Реализация

SessionHandlerInterface::close()

destroy()source public

destroy( string|integer $id )

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

Параметры

строка|целое число $id
Идентификатор, уникально идентифицирующий сессию в кэше.

Возвращает

boolean
Всегда true.

Реализация

SessionHandlerInterface::destroy()

gc()source public

gc( integer $maxlifetime )

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

Параметры

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

Возвращает

boolean
Всегда true.

Реализация

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

write()source public

write( string|integer $id , mixed $data )

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

Параметры

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

Возвращает

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

Реализация

SessionHandlerInterface::write()

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

$_optionssource

protected массив

Параметры для этого движка сессий

[]

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

Spec-Zone.ru

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