Class DatabaseSession

__constructsource public

__construct( )

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

closesource public

close( )

Method called on close of a database session.

Returns

boolean
Success

Implementation of

CakeSessionHandlerInterface::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

CakeSessionHandlerInterface::destroy()

gcsource 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()

opensource public

open( )

Method called on open of a database session.

Returns

boolean
Success

Implementation of

CakeSessionHandlerInterface::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

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

Implementation of

CakeSessionHandlerInterface::read()

writesource 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()