Documentation

MongoStorage extends BaseStorage
in package

Cache storage in a MongoDB database.

Tags
author

Michael Slusarz slusarz@horde.org

category

Horde

copyright

2013-2021 Horde LLC

license

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

Table of Contents

CID  = 'cid'
DATA  = 'data'
EXPIRE  = 'expire'
TIMESTAMP  = 'ts'
$db  : MongoCollection
The MongoDB Collection object for the cache data.
$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
_getCid()  : string
Gets the cache ID for a key.
_initOb()  : mixed
Do initialization tasks.

Constants

Properties

$db

The MongoDB Collection object for the cache data.

protected MongoCollection $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:

  - collection: (string) The collection name.
  - mongodb: [REQUIRED] (Horde_Mongo_Client) A MongoDB client object.
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
inheritDoc
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
inheritDoc
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
inheritDoc
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.

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.

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 —

_getCid()

Gets the cache ID for a key.

protected _getCid(string $key) : string
Parameters
$key : string

The key.

Return values
string —

The cache ID.

_initOb()

Do initialization tasks.

protected _initOb() : mixed
Return values
mixed —

Search results