Interface CakeSessionHandlerInterface
Interface for Session handlers. Custom session handler classes should implement this interface as it allows CakeSession know how to map methods to session_set_save_handler()
Direct Implementers
Package: Cake\Model\Datasource\Session
Copyright: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
License: MIT License
Location: Cake/Model/Datasource/Session/CakeSessionHandlerInterface.php
Copyright: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
License: MIT License
Location: Cake/Model/Datasource/Session/CakeSessionHandlerInterface.php
Method Summary
-
close() public
Method called on close of a session. -
destroy() public
Method called on the destruction of a session. -
gc() public
Run the Garbage collection on the session storage. This method should vacuum all expired or dead sessions.
-
open() public
Method called on open of a session. -
read() public
Method used to read from a session. -
write() public
Helper function called on write for sessions.
Method Detail
destroy() public ¶
destroy( integer $id )
Method called on the destruction of a session.
Parameters
- integer $id
- ID that uniquely identifies session in database
Returns
boolean
True for successful delete, false otherwise.
True for successful delete, false otherwise.
gc() public ¶
gc( integer $expires = null )
Run the Garbage collection on the session storage. This method should vacuum all expired or dead sessions.
Parameters
- integer $expires optional null
- Timestamp (defaults to current time)
Returns
boolean
Success
Success