Documentation

Horde_Core_Cache_Session extends Horde_Cache_Storage_Base
in package

Cache data in session, offloading the data to the cache storage backend when the data becomes too large.

Tags
author

Michael Slusarz slusarz@horde.org

category

Horde

copyright

2014-2017 Horde LLC

license

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

since
2.12.0

Table of Contents

Constants

STORED_KEY  = '_s'

Properties

$_stored  : array<string|int, mixed>
The list of keys stored in the cache backend.

Methods

__construct()  : mixed
clear()  : mixed
exists()  : mixed
expire()  : mixed
get()  : mixed
set()  : mixed
_getCid()  : mixed
_initOb()  : mixed
_saveStored()  : mixed
Save stored list to the session.

Constants

STORED_KEY

public mixed STORED_KEY = '_s'

Properties

$_stored

The list of keys stored in the cache backend.

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

Methods

__construct()

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

Configuration parameters:

  • app: (string) Application to store session data under.
  • cache: (Horde_Cache) [REQUIRED] The backend cache driver used to store large entries.
  • maxsize: (integer) The maximum size of the data to store in the session (0 to always store in session).
  • storage_key: (string) The storage key to save the session data under.

exists()

public exists(mixed $key[, int $lifetime = 0 ]) : mixed
Parameters
$key : mixed
$lifetime : int = 0

Ignored in this driver.

expire()

public expire(mixed $key) : mixed
Parameters
$key : mixed

get()

public get(mixed $key[, int $lifetime = 0 ]) : mixed
Parameters
$key : mixed
$lifetime : int = 0

Ignored in this driver.

set()

public set(mixed $key, mixed $data[, int $lifetime = 0 ]) : mixed
Parameters
$key : mixed
$data : mixed
$lifetime : int = 0

Ignored in this driver.

_getCid()

protected _getCid(mixed $key, mixed $in_session) : mixed
Parameters
$key : mixed
$in_session : mixed

_initOb()

protected _initOb() : mixed

_saveStored()

Save stored list to the session.

protected _saveStored() : mixed

        
On this page

Search results