Documentation

Horde_Cache_Storage_Sql extends Horde_Cache_Storage_Base
in package

Cache storage in a SQL databsae.

The table structure for the cache is as follows:

CREATE TABLE horde_cache (
    cache_id          VARCHAR(32) NOT NULL,
    cache_timestamp   BIGINT NOT NULL,
    cache_data        LONGBLOB,
    (Or on PostgreSQL:)
    cache_data        TEXT,
    (Or on some other DBMS systems:)
    cache_data        IMAGE,

    PRIMARY KEY (cache_id)
);
Tags
author

Ben Klang ben@alkaloid.net

author

Michael Slusarz slusarz@horde.org

category

Horde

copyright

2007-2017 Horde LLC

license

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

Table of Contents

$_db  : Horde_Db_Adapter
Handle for the current database connection.
$_logger  : Horde_Log_Logger
Logger.
$_params  : array<string|int, mixed>
Parameters.
__construct()  : mixed
Constructor.
__destruct()  : mixed
Destructor.
__serialize()  : array<string|int, mixed>
__unserialize()  : void
clear()  : mixed
Clears all data from the cache.
exists()  : bool
Checks if a given key exists in the cache, valid for the given lifetime.
expire()  : bool
Expire any existing data for the given key.
get()  : mixed
Retrieve cached data.
serialize()  : mixed
set()  : mixed
Store an object in the cache.
setLogger()  : mixed
Set the logging object.
unserialize()  : mixed
_initOb()  : mixed
Do initialization tasks.

Properties

$_db

Handle for the current database connection.

protected Horde_Db_Adapter $_db

$_logger

Logger.

protected Horde_Log_Logger $_logger

$_params

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 cache table.
           DEFAULT: 'horde_cache'
Return values
mixed —

__destruct()

Destructor.

public __destruct() : mixed
Return values
mixed —

__serialize()

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

__unserialize()

public __unserialize(array<string|int, mixed> $data) : void
Parameters
$data : array<string|int, mixed>
Return values
void —

clear()

Clears all data from the cache.

public clear() : mixed
Return values
mixed —

exists()

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

public exists(mixed $key, mixed $lifetime) : bool
Parameters
$key : mixed

Cache key to check.

$lifetime : mixed

Lifetime of the key in seconds.

Return values
bool —

Existence.

expire()

Expire any existing data for the given key.

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

Cache key to expire.

Return values
bool —

Success or failure.

get()

Retrieve cached data.

public get(mixed $key, mixed $lifetime) : mixed
Parameters
$key : mixed

Object ID to query.

$lifetime : mixed

Lifetime of the object in seconds.

Return values
mixed —

Cached data, or false if none was found.

serialize()

public serialize() : mixed
Return values
mixed —

set()

Store an object in the cache.

public set(mixed $key, mixed $data, mixed $lifetime) : mixed
Parameters
$key : mixed

Object ID used as the caching key.

$data : mixed

Data to store in the cache.

$lifetime : mixed

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

Return values
mixed —

setLogger()

Set the logging object.

public setLogger(Horde_Log_Logger $logger) : mixed
Parameters
$logger : Horde_Log_Logger

Log object.

Return values
mixed —

unserialize()

public unserialize(mixed $data) : mixed
Parameters
$data : mixed
Return values
mixed —

_initOb()

Do initialization tasks.

protected _initOb() : mixed
Return values
mixed —

Search results