Documentation

Horde_SessionHandler_Storage_Sql extends Horde_SessionHandler_Storage
in package

SessionHandler storage implementation for SQL databases.

Uses the following SQL table structure:

CREATE TABLE horde_sessionhandler (
    VARCHAR(32) NOT NULL,
    session_lastmodified   INT NOT NULL,
    session_data           LONGBLOB,
    -- Or, on some DBMS systems:
    --  session_data           IMAGE,

    PRIMARY KEY (session_id)
);

CREATE INDEX session_lastmodified_idx ON horde_sessionhandler (session_lastmodified);

Copyright 2002-2017 Horde LLC (http://www.horde.org/)

See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Tags
author

Mike Cochrane mike@graftonhall.co.nz

category

Horde

license

http://www.horde.org/licenses/lgpl21 LGPL 2.1

Table of Contents

$readonly  : bool
Access session read-only?
$_db  : Horde_Db_Adapter
Handle for the current database connection.
$_params  : array<string|int, mixed>
Hash containing connection parameters.
__construct()  : mixed
Constructor.
__sleep()  : mixed
Storage objects do not support serialization.
close()  : mixed
Close the backend.
destroy()  : bool
Destroy the data for a particular session identifier in the backend.
gc()  : bool
Garbage collect stale sessions from the backend.
getSessionIDs()  : array<string|int, mixed>
Get a list of the valid session identifiers.
open()  : mixed
Open the backend.
read()  : string
Read the data for a particular session identifier from the backend.
setLogger()  : mixed
Set the logger object.
write()  : bool
Write session data to the backend.

Properties

$readonly

Access session read-only?

public bool $readonly = \false

$_db

Handle for the current database connection.

protected Horde_Db_Adapter $_db

$_params

Hash containing connection parameters.

protected array<string|int, mixed> $_params = array()

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $params = array() ]) : mixed
Parameters
$params : array<string|int, mixed> = array()

Parameters:

'db' - (Horde_Db_Adapter) [REQUIRED] The DB instance.
'table' - (string) The name of the sessions table.
          DEFAULT: 'horde_sessionhandler'
Tags
throws
InvalidArgumentException
Return values
mixed —

__sleep()

Storage objects do not support serialization.

public __sleep() : mixed
Return values
mixed —

close()

Close the backend.

public close() : mixed
Return values
mixed —

destroy()

Destroy the data for a particular session identifier in the backend.

public destroy(mixed $id) : bool
Parameters
$id : mixed

The session identifier.

Return values
bool —

True on success, false otherwise.

gc()

Garbage collect stale sessions from the backend.

public gc([mixed $maxlifetime = 300 ]) : bool
Parameters
$maxlifetime : mixed = 300

The maximum age of a session.

Return values
bool —

True on success, false otherwise.

getSessionIDs()

Get a list of the valid session identifiers.

public getSessionIDs() : array<string|int, mixed>
Return values
array<string|int, mixed> —

A list of valid session identifiers.

open()

Open the backend.

public open([mixed $save_path = null ][, mixed $session_name = null ]) : mixed
Parameters
$save_path : mixed = null

The path to the session object.

$session_name : mixed = null

The name of the session.

Return values
mixed —

read()

Read the data for a particular session identifier from the backend.

public read(mixed $id) : string
Parameters
$id : mixed

The session identifier.

Return values
string —

The session data.

setLogger()

Set the logger object.

public setLogger(Horde_Log_Logger $log) : mixed
Parameters
$log : Horde_Log_Logger
Tags
deprecated
Return values
mixed —

write()

Write session data to the backend.

public write(mixed $id, mixed $session_data) : bool
Parameters
$id : mixed

The session identifier.

$session_data : mixed

The session data.

Return values
bool —

True on success, false otherwise.

Search results