W3cubDocs

/CakePHP 3.8

Class CacheSession

CacheSession provides method for saving sessions into a Cache engine. Used with Session

Cake\Http\Session\CacheSession implements SessionHandlerInterface
Namespace: Cake\Http\Session
See: \Cake\Model\Datasource\Session for configuration information.
Location: Http/Session/CacheSession.php

Properties summary

  • $_options protected
    array
    Options for this session engine

Method Summary

  • __construct() public
    Constructor.
  • close() public
    Method called on close of a database session.
  • destroy() public
    Method called on the destruction of a cache session.
  • gc() public
    Helper function called on gc for cache sessions.
  • open() public
    Method called on open of a database session.
  • read() public
    Method used to read from a cache session.
  • write() public
    Helper function called on write for cache sessions.

Method Detail

__construct()source public

__construct( array $config = [] )

Constructor.

Parameters

array $config optional []

The configuration to use for this engine It requires the key 'config' which is the name of the Cache config to use for storing the session

Throws

InvalidArgumentException
if the 'config' key is not provided

close()source public

close( )

Method called on close of a database session.

Returns

boolean
Success

Implementation of

SessionHandlerInterface::close()

destroy()source public

destroy( string|integer $id )

Method called on the destruction of a cache session.

Parameters

string|integer $id
ID that uniquely identifies session in cache.

Returns

boolean
Always true.

Implementation of

SessionHandlerInterface::destroy()

gc()source public

gc( integer $maxlifetime )

Helper function called on gc for cache sessions.

Parameters

integer $maxlifetime
Sessions that have not updated for the last maxlifetime seconds will be removed.

Returns

boolean
Always true.

Implementation of

SessionHandlerInterface::gc()

open()source public

open( string $savePath , string $name )

Method called on open of a database session.

Parameters

string $savePath
The path where to store/retrieve the session.
string $name
The session name.

Returns

boolean
Success

Implementation of

SessionHandlerInterface::open()

read()source public

read( string|integer $id )

Method used to read from a cache session.

Parameters

string|integer $id
ID that uniquely identifies session in cache.

Returns

string
Session data or empty string if it does not exist.

Implementation of

SessionHandlerInterface::read()

write()source public

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

Helper function called on write for cache sessions.

Parameters

string|integer $id
ID that uniquely identifies session in cache.
mixed $data
The data to be saved.

Returns

boolean
True for successful write, false otherwise.

Implementation of

SessionHandlerInterface::write()

Properties detail

$_optionssource

protected array

Options for this session engine

[]

© 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