Class DatabaseSession
DatabaseSession provides methods to be used with CakeSession.
- DatabaseSession implements CakeSessionHandlerInterface
Copyright: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
License: MIT License
Location: Cake/Model/Datasource/Session/DatabaseSession.php
Properties summary
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. -
open() public
Method called on open of a database session. -
read() public
Method used to read from a database session. -
write() public
Helper function called on write for database sessions.
Method Detail
__construct() public ¶
__construct( )
Constructor. Looks at Session configuration information and sets up the session model.
close() public ¶
close( )
Method called on close of a database session.
Returns
Success
Implementation of
destroy() public ¶
destroy( integer $id )
Method called on the destruction of a database session.
Parameters
- integer $id
- ID that uniquely identifies session in database
Returns
True for successful delete, false otherwise.
Implementation of
gc() public ¶
gc( integer $expires = null )
Helper function called on gc for database sessions.
Parameters
- integer $expires optional null
- Timestamp (defaults to current time)
Returns
Success
Implementation of
open() public ¶
open( )
Method called on open of a database session.
Returns
Success
Implementation of
read() public ¶
read( integer|string $id )
Method used to read from a database session.
Parameters
- integer|string $id
- The key of the value to read
Returns
The value of the key or false if it does not exist
Implementation of
write() public ¶
write( integer $id , mixed $data )
Helper function called on write for database sessions.
Will retry, once, if the save triggers a PDOException which can happen if a race condition is encountered
Parameters
- integer $id
- ID that uniquely identifies session in database
- mixed $data
- The value of the data to be saved.
Returns
True for successful write, false otherwise.