Class DatabaseSession
DatabaseSession provides methods to be used with Session.
- Cake\Http\Session\DatabaseSession implements SessionHandlerInterface uses Cake\ORM\Locator\LocatorAwareTrait
Properties summary
Inherited Properties
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. -
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
Success
Implementation of
SessionHandlerInterface::close()destroy() public ¶
destroy( string|integer $id )
Method called on the destruction of a database session.
Parameters
- string|integer $id
- ID that uniquely identifies session in database.
Returns
True for successful delete, false otherwise.
Implementation of
SessionHandlerInterface::destroy()gc() public ¶
gc( integer $maxlifetime )
Helper function called on gc for database sessions.
Parameters
- integer $maxlifetime
- Sessions that have not updated for the last maxlifetime seconds will be removed.
Returns
True on success, false on failure.
Implementation of
SessionHandlerInterface::gc()open() 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
Success
Implementation of
SessionHandlerInterface::open()read() public ¶
read( string|integer $id )
Method used to read from a database session.
Parameters
- string|integer $id
- ID that uniquely identifies session in database.
Returns
Session data or empty string if it does not exist.
Implementation of
SessionHandlerInterface::read()setTimeout() public ¶
setTimeout( integer $timeout )
Set the timeout value for sessions.
Primarily used in testing.
Parameters
- integer $timeout
- The timeout duration.
Returns
$this
write() public ¶
write( string|integer $id , mixed $data )
Helper function called on write for database sessions.
Parameters
- string|integer $id
- ID that uniquely identifies session in database.
- mixed $data
- The data to be saved.
Returns
True for successful write, false otherwise.
Implementation of
SessionHandlerInterface::write()Methods used from Cake\ORM\Locator\LocatorAwareTrait
setTableLocator() public ¶
setTableLocator( Cake\ORM\Locator\LocatorInterface $tableLocator )
Sets the table locator.
Parameters
-
Cake\ORM\Locator\LocatorInterface$tableLocator - LocatorInterface instance.
Returns
$this
tableLocator() public ¶
tableLocator( Cake\ORM\Locator\LocatorInterface $tableLocator null )
Sets the table locator. If no parameters are passed, it will return the currently used locator.
Deprecated
Parameters
-
Cake\ORM\Locator\LocatorInterface$tableLocator optional null - LocatorInterface instance.