W3cubDocs

/CakePHP 4.1

Class CacheSession

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

Namespace: Cake\Http\Session

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

    No-op method. Always returns true since cache engine don't have garbage collection.

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

close()

Method called on close of a database session.

Returns

bool

Success

destroy() public 

destroy(mixed $id)

Method called on the destruction of a cache session.

Parameters

string $id

ID that uniquely identifies session in cache.

Returns

bool

Always true.

gc() public 

gc(mixed $maxlifetime)

No-op method. Always returns true since cache engine don't have garbage collection.

Parameters

int $maxlifetime

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

Returns

bool

Always true.

open() public 

open(mixed $savePath, mixed $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

bool

Success

read() public 

read(mixed $id)

Method used to read from a cache session.

Parameters

string $id

ID that uniquely identifies session in cache.

Returns

string

Session data or empty string if it does not exist.

write() public 

write(mixed $id, mixed $data)

Helper function called on write for cache sessions.

Parameters

string $id

ID that uniquely identifies session in cache.

string $data

The data to be saved.

Returns

bool

True for successful write, false otherwise.

Property Detail

$_options protected

Options for this session engine

Type

array

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