\Horde_Cache_Storage_Memoryoverlay

A memory overlay for a cache backend. Caches results in PHP memory for the current access so the underlying cache backend is not continually hit.

Summary

Methods
Properties
Constants
__construct()
setLogger()
get()
set()
exists()
expire()
clear()
serialize()
unserialize()
No public properties found
No constants found
_initOb()
$_logger
$_params
N/A
No private methods found
$_cache
N/A

Properties

$_logger

$_logger : \Horde_Log_Logger

Logger.

Type

\Horde_Log_Logger

$_params

$_params : array

Parameters.

Type

array

$_cache

$_cache : array

The memory cache.

Type

array

Methods

__construct()

__construct(array  $params = array()) 

Constructor.

Parameters

array $params

Parameters:

  - backend: (Horde_Cache_Storage_Base) [REQUIRED] The master storage
             backend.

setLogger()

setLogger(\Horde_Log_Logger  $logger) 

Set the logging object.

Parameters

\Horde_Log_Logger $logger

Log object.

get()

get(string  $key, integer  $lifetime) : mixed

Retrieve cached data.

Parameters

string $key

Object ID to query.

integer $lifetime

Lifetime of the object in seconds.

Returns

mixed —

Cached data, or false if none was found.

set()

set(string  $key, mixed  $data, integer  $lifetime) 

Store an object in the cache.

Parameters

string $key

Object ID used as the caching key.

mixed $data

Data to store in the cache.

integer $lifetime

Object lifetime - i.e. the time before the data becomes available for garbage collection. If 0 will not be GC'd.

exists()

exists(string  $key, integer  $lifetime) : boolean

Checks if a given key exists in the cache, valid for the given lifetime.

Parameters

string $key

Cache key to check.

integer $lifetime

Lifetime of the key in seconds.

Returns

boolean —

Existence.

expire()

expire(string  $key) : boolean

Expire any existing data for the given key.

Parameters

string $key

Cache key to expire.

Returns

boolean —

Success or failure.

clear()

clear() 

Clears all data from the cache.

serialize()

serialize() 

unserialize()

unserialize(  $data) 

Parameters

$data

_initOb()

_initOb() 

Do initialization tasks.