Class DatabaseSession
DatabaseSession provides methods to be used with Session.
- Cake\Network\Session\DatabaseSession implements SessionHandlerInterface
Method Detail
__constructsource 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.
closesource public
close( )
Method called on close of a database session.
Returns
boolean
Success
Implementation of
SessionHandlerInterface::close()
destroysource public
destroy( integer $id )
Method called on the destruction of a database session.
Parameters
- integer
$id
- ID that uniquely identifies session in database
Returns
boolean
True for successful delete, false otherwise.
Implementation of
SessionHandlerInterface::destroy()
gcsource public
gc( string $maxlifetime )
Helper function called on gc for database sessions.
Parameters
- string
$maxlifetime
- Sessions that have not updated for the last maxlifetime seconds will be removed.
Returns
boolean
True on success, false on failure.
Implementation of
SessionHandlerInterface::gc()
opensource 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()
readsource 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
string
The value of the key or empty if it does not exist
Implementation of
SessionHandlerInterface::read()
writesource public
write( integer $id , mixed $data )
Helper function called on write for database sessions.
Parameters
- integer
$id
- ID that uniquely identifies session in database
- mixed
$data
- The value of the data to be saved.
Returns
boolean
True for successful write, false otherwise.
Implementation of
SessionHandlerInterface::write()
Properties summary
© 2005–2016 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.
http://api.cakephp.org/3.1/class-Cake.Network.Session.DatabaseSession.html