SqlStorage
extends BaseStorage
in package
Cache storage in a SQL databsae.
The table structure for the cache is as follows:
CREATE TABLE hordecache (
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
Table of Contents
- $db : Horde_Db_Adapter
- Handle for the current database connection.
- $logger : Horde_Log_Logger|null
- 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() : string
- set() : mixed
- Store an object in the cache.
- setLogger() : void
- 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|null
$logger
$params
Parameters.
protected
array<string|int, mixed>
$params
= []
Methods
__construct()
Constructor.
public
__construct([array<string|int, mixed> $params = [] ]) : mixed
Parameters
- $params : array<string|int, mixed> = []
-
Parameters:
- db: (Horde_Db_Adapter) [REQUIRED] The DB instance. - table: (string) The name of the cache table. DEFAULT: 'hordecache'
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
Tags
Return values
mixed —exists()
Checks if a given key exists in the cache, valid for the given lifetime.
public
exists(string $key, int $lifetime) : bool
Parameters
- $key : string
-
Cache key to check.
- $lifetime : int
-
Lifetime of the key in seconds.
Tags
Return values
bool —Existence.
expire()
Expire any existing data for the given key.
public
expire(string $key) : bool
Parameters
- $key : string
-
Cache key to expire.
Tags
Return values
bool —Success or failure.
get()
Retrieve cached data.
public
get(string $key, int $lifetime) : mixed
Parameters
- $key : string
-
Object ID to query.
- $lifetime : int
-
Lifetime of the object in seconds.
Tags
Return values
mixed —Cached data, or false if none was found.
serialize()
public
serialize() : string
Return values
string —set()
Store an object in the cache.
public
set(string $key, mixed $data, int $lifetime) : mixed
Parameters
- $key : string
-
Object ID used as the caching key.
- $data : mixed
-
Data to store in the cache.
- $lifetime : int
-
Object lifetime - i.e. the time before the data becomes available for garbage collection. If 0 will not be GC'd.
Tags
Return values
mixed —setLogger()
Set the logging object.
public
setLogger(Horde_Log_Logger $logger) : void
Parameters
- $logger : Horde_Log_Logger
-
Log object.
Return values
void —unserialize()
public
unserialize(mixed $data) : mixed
Parameters
- $data : mixed
Return values
mixed —_initOb()
Do initialization tasks.
protected
_initOb() : mixed