PHP Class Horde_Imap_Client_Cache_Backend_Mongo, horde

Requires the Horde_Mongo class.

Author: Michael Slusarz ([email protected])

Inheritance: extends Horde_Imap_Client_Cache_Backend, implements Horde_Mongo_Collection_Index

Mostrar archivo Open project: horde/horde

Protected Properties

Property	Type	Description
$_db	MongoDB	The MongoDB object for the cache data.
$_indices	array	The list of indices.

Public Methods

Method	Description
__construct ( array $params = [] )	Constructor.
checkMongoIndices ( )
clear ( $lifetime )
createMongoIndices ( )
deleteMailbox ( $mailbox )
deleteMsgs ( $mailbox, $uids )
get ( $mailbox, $uids, $fields, $uidvalid )
getCachedUids ( $mailbox, $uidvalid )
getMetaData ( $mailbox, $uidvalid, $entries )
set ( $mailbox, $data, $uidvalid )
setMetaData ( $mailbox, $data )

Protected Methods

Method	Description
_createUid ( string $mailbox ) : string	Create and return the UID for a mailbox/user/server combo.
_getUid ( string $mailbox ) : string	Return the UID for a mailbox/user/server combo.
_initOb ( )
_value ( mixed \| MongoBinData $data ) : mixed \| MongoBinData	Convert data from/to storage format.

Method Details

__construct() public method

Constructor.

public __construct ( array $params = [] )
$params	array	Configuration parameters: - REQUIRED parameters: - mongo_db: (Horde_Mongo_Client) A MongoDB client object.

_createUid() protected method

Create and return the UID for a mailbox/user/server combo.

protected _createUid ( string $mailbox ) : string
$mailbox	string	Mailbox name.
return	string	UID from base table.

_getUid() protected method

Return the UID for a mailbox/user/server combo.

protected _getUid ( string $mailbox ) : string
$mailbox	string	Mailbox name.
return	string	UID from base table.

_initOb() protected method

protected _initOb ( )

_value() protected method

Convert data from/to storage format.

protected _value ( mixed \| MongoBinData $data ) : mixed \| MongoBinData
$data	mixed \| MongoBinData	The data object.
return	mixed \| MongoBinData	The converted data.

checkMongoIndices() public method

public checkMongoIndices ( )

clear() public method

public clear ( $lifetime )

createMongoIndices() public method

public createMongoIndices ( )

deleteMailbox() public method

public deleteMailbox ( $mailbox )

deleteMsgs() public method

public deleteMsgs ( $mailbox, $uids )

get() public method

public get ( $mailbox, $uids, $fields, $uidvalid )

getCachedUids() public method

public getCachedUids ( $mailbox, $uidvalid )

getMetaData() public method

public getMetaData ( $mailbox, $uidvalid, $entries )

set() public method

public set ( $mailbox, $data, $uidvalid )

setMetaData() public method

public setMetaData ( $mailbox, $data )

Property Details

$_db protected_oe property

The MongoDB object for the cache data.

protected MongoDB $_db
return	MongoDB

$_indices protected_oe property

The list of indices.

protected array $_indices
return	array