Documentation

Horde_Core_Factory_SessionHandler extends Horde_Core_Factory_Injector
in package

Factory for creating Horde_SessionHandler objects.

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

Tags
category

Horde

Table of Contents

Properties

$storage  : Horde_SessionHandler_Storage
Storage driver.
$_injector  : Horde_Injector
The injector.

Methods

__construct()  : mixed
Constructor.
create()  : Horde_SessionHandler_Driver
Attempts to return a concrete instance based on $driver.
readSessionData()  : array<string|int, mixed>
Reads session data to determine if it contains Horde authentication credentials.
_getDriverName()  : string
Return the classname of the driver to load.
_returnTrue()  : bool
Stub method.

Properties

$storage

Storage driver.

public Horde_SessionHandler_Storage $storage
Tags
since
2.5.0

$_injector

The injector.

protected Horde_Injector $_injector

Methods

__construct()

Constructor.

public __construct(Horde_Injector $injector) : mixed
Parameters
$injector : Horde_Injector

The injector to use.

create()

Attempts to return a concrete instance based on $driver.

public create(Horde_Injector $injector) : Horde_SessionHandler_Driver
Parameters
$injector : Horde_Injector
Tags
throws
Horde_SessionHandler_Exception
Return values
Horde_SessionHandler_Driver

The newly created concrete instance.

readSessionData()

Reads session data to determine if it contains Horde authentication credentials.

public readSessionData(string $session_data) : array<string|int, mixed>
Parameters
$session_data : string

The session data.

Return values
array<string|int, mixed>

An array of the user's sesion information if authenticated or false. The following information is returned: userid, timestamp, remoteAddr, browser, apps.

_getDriverName()

Return the classname of the driver to load.

protected _getDriverName(string $driver, string $base) : string
Parameters
$driver : string

Driver name.

$base : string

The base classname.

Tags
throws
Horde_Exception
Return values
string

Classname.

_returnTrue()

Stub method.

protected _returnTrue() : bool
Return values
bool

True


        
On this page

Search results