Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 3.9.x will end* 10 May 2021 (12 months).
  • Bug fixes for security issues in 3.9.x will end* 8 May 2023 (36 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.

Differences Between: [Versions 39 and 401] [Versions 39 and 402] [Versions 39 and 403]

Copyright 2005-2017 Horde LLC (http://www.horde.org/) See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Copyright: 2005-2017 Horde LLC
License: http://www.horde.org/licenses/lgpl21 LGPL 2.1
File Size: 506 lines (15 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Horde_Imap_Client_Cache_Backend_Cache:: (18 methods):
  __construct()
  _initOb()
  save()
  get()
  getCachedUids()
  set()
  getMetaData()
  setMetaData()
  deleteMsgs()
  deleteMailbox()
  clear()
  _getCid()
  _deleteMailbox()
  _loadUids()
  _loadSlice()
  _loadSliceMap()
  _toUpdate()
  serialize()


Class: Horde_Imap_Client_Cache_Backend_Cache  - X-Ref

A Horde_Cache implementation for caching IMAP/POP data.
Requires the Horde_Cache package.

__construct(array $params = array()   X-Ref
Constructor.

param: array $params  Configuration parameters:

_initOb()   X-Ref
Initialization tasks.


save()   X-Ref
Updates the cache.


get($mailbox, $uids, $fields, $uidvalid)   X-Ref
No description

getCachedUids($mailbox, $uidvalid)   X-Ref
No description

set($mailbox, $data, $uidvalid)   X-Ref
No description

getMetaData($mailbox, $uidvalid, $entries)   X-Ref
No description

setMetaData($mailbox, $data)   X-Ref
No description

deleteMsgs($mailbox, $uids)   X-Ref
No description

deleteMailbox($mailbox)   X-Ref
No description

clear($lifetime)   X-Ref
No description

_getCid($mailbox, $slice)   X-Ref
Create the unique ID used to store the data in the cache.

param: string $mailbox  The mailbox to cache.
param: string $slice    The cache slice.
return: string  The cache ID.

_deleteMailbox($mbox)   X-Ref
Delete a mailbox from the cache.

param: string $mbox  The mailbox to delete.

_loadUids($mailbox, $uids, $uidvalid = null)   X-Ref
Load UIDs by regenerating from the cache.

param: string $mailbox    The mailbox to load.
param: array $uids        The UIDs to load.
param: integer $uidvalid  The IMAP uidvalidity value of the mailbox.

_loadSlice($mailbox, $slice)   X-Ref
Load UIDs from a cache slice.

param: string $mailbox  The mailbox to load.
param: integer $slice   The slice to load.

_loadSliceMap($mailbox, $uidvalid = null)   X-Ref
Load the slicemap for a given mailbox.  The slicemap contains
the uidvalidity information, the UIDs->slice lookup table, and any
metadata that needs to be saved for the mailbox.

param: string $mailbox    The mailbox.
param: integer $uidvalid  The IMAP uidvalidity value of the mailbox.

_toUpdate($mailbox, $type, $data)   X-Ref
Add update entry for a mailbox.

param: string $mailbox  The mailbox.
param: string $type     'add', 'slice', or 'slicemap'.
param: mixed $data      The data to update.

serialize()   X-Ref
No description