W3cubDocs

/CakePHP 4.1

Class DatabaseSession

DatabaseSession provides methods to be used with Session.

Namespace: Cake\Http\Session

Properties summary

  • $_table protected
    \Cake\ORM\Table

    Reference to the table handling the session data

  • $_tableLocator protected
    \Cake\ORM\Locator\LocatorInterface|null

    Table locator instance

  • $_timeout protected
    int

    Number of seconds to mark the session as expired

Method Summary

  • __construct() public

    Constructor. Looks at Session configuration information and sets up the session model.

  • close() public

    Method called on close of a database session.

  • destroy() public

    Method called on the destruction of a database session.

  • gc() public

    Helper function called on gc for database sessions.

  • getTableLocator() public

    Gets the table locator.

  • open() public

    Method called on open of a database session.

  • read() public

    Method used to read from a database session.

  • setTableLocator() public

    Sets the table locator.

  • setTimeout() public

    Set the timeout value for sessions.

  • write() public

    Helper function called on write for database sessions.

Method Detail

__construct() public 

__construct(array $config)

Constructor. Looks at Session configuration information and sets up the session model.

Parameters

array $config optional

The configuration for this engine. It requires the 'model' key to be present corresponding to the Table to use for managing the sessions.

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 database session.

Parameters

string $id

ID that uniquely identifies session in database.

Returns

bool

True for successful delete, false otherwise.

gc() public 

gc(mixed $maxlifetime)

Helper function called on gc for database sessions.

Parameters

int $maxlifetime

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

Returns

bool

True on success, false on failure.

getTableLocator() public 

getTableLocator()

Gets the table locator.

Returns

\Cake\ORM\Locator\LocatorInterface

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 database session.

Parameters

string $id

ID that uniquely identifies session in database.

Returns

string

Session data or empty string if it does not exist.

setTableLocator() public 

setTableLocator(\Cake\ORM\Locator\LocatorInterface $tableLocator)

Sets the table locator.

Parameters

\Cake\ORM\Locator\LocatorInterface $tableLocator

LocatorInterface instance.

Returns

$this

setTimeout() public 

setTimeout(int $timeout)

Set the timeout value for sessions.

Primarily used in testing.

Parameters

int $timeout

The timeout duration.

Returns

$this

write() public 

write(mixed $id, mixed $data)

Helper function called on write for database sessions.

Parameters

string $id

ID that uniquely identifies session in database.

string $data

The data to be saved.

Returns

bool

True for successful write, false otherwise.

Property Detail

$_table protected

Reference to the table handling the session data

Type

\Cake\ORM\Table

$_tableLocator protected

Table locator instance

Type

\Cake\ORM\Locator\LocatorInterface|null

$_timeout protected

Number of seconds to mark the session as expired

Type

int

© 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.DatabaseSession.html