DatabaseHandler

Implements HandlerInterface

Database session storage handler

since

2.0.0

package

Joomla Framework

Methods

__construct

Constructor

__construct(\Joomla\Database\DatabaseInterface db) : mixed
since

2.0.0

Arguments

db

\Joomla\Database\DatabaseInterfaceDatabase connector

Response

mixed

close

Close the session

close() : bool
since

2.0.0

Response

boolTrue on success, false otherwise

createDatabaseTable

Creates the session database table

createDatabaseTable() : bool
since

2.0.0

throws

\Joomla\Session\Exception\CreateSessionTableException

\Joomla\Session\Exception\UnsupportedDatabaseDriverException

Response

bool

destroy

Destroy a session

destroy(int session_id) : bool
since

2.0.0

Arguments

session_id

intThe session ID being destroyed

Response

boolTrue on success, false otherwise

gc

Cleanup old sessions

gc(int maxlifetime) : bool
since

2.0.0

Arguments

maxlifetime

intSessions that have not updated for the last maxlifetime seconds will be removed

Response

boolTrue on success, false otherwise

isSupported

Test to see if the HandlerInterface is available

isSupported() : bool
static
since

2.0.0

Response

boolTrue on success, false otherwise

open

Initialize session

open(string save_path, string session_id) : bool
since

2.0.0

Arguments

save_path

stringThe path where to store/retrieve the session

session_id

stringThe session id

Response

boolTrue on success, false otherwise

read

Read session data

read(string session_id) : string
since

2.0.0

Arguments

session_id

stringThe session id to read data for

Response

stringThe session data

write

Write session data

write(string session_id, string session_data) : bool
since

2.0.0

Arguments

session_id

stringThe session id

session_data

stringThe encoded session data

Response

boolTrue on success, false otherwise

Properties

db

Database connector

since

2.0.0

Type(s)

\Joomla\Database\DatabaseInterface

gcCalled

Flag whether gc() has been called

since

2.0.0

Type(s)

bool

gcLifetime

Lifetime for garbage collection

since

2.0.0

Type(s)

int