SessionHandlerDB class

Session handler for storing sessions to database

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the SessionHandlerDB class also inherits all the methods and properties of: WireSessionHandler, WireData and Wire.

Common
Properties

Common

Name	Return	Summary
SessionHandlerDB::destroy() SessionHandlerDB::destroy(string $id) SessionHandlerDB::destroy(string $id)	`bool`	Destroy the session indicated by the given session ID
SessionHandlerDB::gc() SessionHandlerDB::gc(int $seconds) SessionHandlerDB::gc(int $seconds)	`bool`	Garbage collection: remove stale sessions
SessionHandlerDB::getModuleConfigInputfields() SessionHandlerDB::getModuleConfigInputfields(array $data) SessionHandlerDB::getModuleConfigInputfields(array $data)	`InputfieldWrapper`	Session configuration options
SessionHandlerDB::getModuleInfo() SessionHandlerDB::getModuleInfo() SessionHandlerDB::getModuleInfo()	None
SessionHandlerDB::getNumSessions() SessionHandlerDB::getNumSessions() SessionHandlerDB::getNumSessions(int $seconds = 300)	`int`	Return the number of active sessions in the last 5 mins (300 seconds)
SessionHandlerDB::getSessionData() SessionHandlerDB::getSessionData($sessionID) SessionHandlerDB::getSessionData($sessionID)	`array`	Return all session data for the given session ID
SessionHandlerDB::getSessions() SessionHandlerDB::getSessions() SessionHandlerDB::getSessions(int $seconds = 300, int $limit = 100)	`array`	Get the most recent sessions
SessionHandlerDB::hookLoginSuccess() SessionHandlerDB::hookLoginSuccess(HookEvent $event) SessionHandlerDB::hookLoginSuccess(HookEvent $event)	None	Hook called after Session::loginSuccess to enforce the noPS option
SessionHandlerDB::init() SessionHandlerDB::init() SessionHandlerDB::init()	None
SessionHandlerDB::install() SessionHandlerDB::install() SessionHandlerDB::install()	None	Install sessions table
SessionHandlerDB::read() SessionHandlerDB::read(string $id) SessionHandlerDB::read(string $id)	`string`	Read and return data for session indicated by $id
SessionHandlerDB::uninstall() SessionHandlerDB::uninstall() SessionHandlerDB::uninstall()	None	Drop sessions table
SessionHandlerDB::upgrade() SessionHandlerDB::upgrade(int $fromVersion, int $toVersion) SessionHandlerDB::upgrade(int $fromVersion, int $toVersion)	None	Upgrade module version
SessionHandlerDB::wired() SessionHandlerDB::wired() SessionHandlerDB::wired()	None
SessionHandlerDB::write() SessionHandlerDB::write(string $id, string $data) SessionHandlerDB::write(string $id, string $data)	`bool`	Write the given $data for the given session ID

Properties

Name	Return	Summary
SessionHandlerDB::lockSeconds	`int`	Max number of seconds to wait to obtain DB row lock.
SessionHandlerDB::noPS	`int` `bool`	Prevent more than one session per logged-in user?
SessionHandlerDB::retrySeconds	`int`	Seconds after which to retry after a lock fail.
SessionHandlerDB::useIP	`int` `bool`	Track IP address?
SessionHandlerDB::useUA	`int` `bool`	Track user agent?

Additional methods and properties

In addition to the methods and properties above, SessionHandlerDB also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.252