Class DatabaseSession

DatabaseSession provides methods to be used with CakeSession.

DatabaseSession implements CakeSessionHandlerInterface
Package: Cake\Model\Datasource\Session
Copyright: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
License: MIT License
Location: Cake/Model/Datasource/Session/DatabaseSession.php

Properties summary

  • $_model protected
    Model
    Reference to the model handling the session data
  • $_timeout protected
    integer
    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.
  • 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()source public 

__construct( )

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

close()source public 

close( )

Method called on close of a database session.

Returns

boolean
Success

Implementation of

CakeSessionHandlerInterface::close()

destroy()source 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

CakeSessionHandlerInterface::destroy()

gc()source public 

gc( integer $expires null )

Helper function called on gc for database sessions.

Parameters

integer $expires optional null
Timestamp (defaults to current time)

Returns

boolean
Success

Implementation of

CakeSessionHandlerInterface::gc()

open()source public 

open( )

Method called on open of a database session.

Returns

boolean
Success

Implementation of

CakeSessionHandlerInterface::open()

read()source 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

mixed
The value of the key or false if it does not exist

Implementation of

CakeSessionHandlerInterface::read()

write()source 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

boolean
True for successful write, false otherwise.

Implementation of

CakeSessionHandlerInterface::write()

Properties detail

$_modelsource

protected Model

Reference to the model handling the session data

$_timeoutsource

protected integer

Number of seconds to mark the session as expired

© 2005–2017 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/2.10/class-DatabaseSession.html