Class Horde_Kolab_FreeBusy_Cache_DB

Description

A berkeley db based cache for free/busy data.

$Horde: framework/Kolab_FreeBusy/lib/Horde/Kolab/FreeBusy/Cache/DB.php,v 1.1.2.1 2010/05/16 06:22:09 wrobel Exp $

Copyright 2004-2008 Klarälvdalens Datakonsult AB

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

Located in /Kolab_FreeBusy/lib/Horde/Kolab/FreeBusy/Cache/DB.php (line 32)


	
			
Direct descendents
Class Description
 class Horde_Kolab_FreeBusy_Cache_DB_acl A berkeley db based cache for free/busy data that holds relevant cache files based on folder ACLs.
 class Horde_Kolab_FreeBusy_Cache_DB_xacl A berkeley db based cache for free/busy data that holds relevant cache files based on extended folder ACLs.
Variable Summary
 string $_cache_dir
 resource $_db
 string $_dbformat
 string $_type
Method Summary
 static FreeBusyACLCache &singleton (string $type, string $cache_dir)
 Horde_Kolab_FreeBusy_Cache_DB Horde_Kolab_FreeBusy_Cache_DB ( $cache_dir)
 array|PEAR_Error get (string $uid)
 boolean|PEAR_Error has (string $filename, string $uid)
 boolean|PEAR_Error _add (string $filename, string $uid)
 void _close ()
 boolean _notEmpty (mixed $value)
 boolean|PEAR_Error _open ()
 boolean|PEAR_Error _remove (string $filename, string $uid)
Variables
string $_cache_dir (line 39)

The directory that should be used for caching.

resource $_db = false (line 46)

The resource handle into the database.

string $_dbformat (line 53)

The format of the database.

string $_type = '' (line 60)

The type of this cache.


Redefined in descendants as:
Methods
static singleton (line 265)

Attempts to return a reference to a concrete FreeBusyACLCache instance. It will only create a new instance if no FreeBusyACLCache instance currently exists.

This method must be invoked as:

  1. $var &FreeBusyACLCache::singleton($cache_dir);

  • return: The concrete FreeBusyACLCache reference, or false on an error.
static FreeBusyACLCache &singleton (string $type, string $cache_dir)
  • string $type: The type of the cache.
  • string $cache_dir: The directory for storing the cache.
Constructor Horde_Kolab_FreeBusy_Cache_DB (line 67)

The directory that should be used for caching.

Horde_Kolab_FreeBusy_Cache_DB Horde_Kolab_FreeBusy_Cache_DB ( $cache_dir)
  • $cache_dir
get (line 219)

Get the full list of relevant cache files for a uid.

  • return: The list of cache files.
array|PEAR_Error get (string $uid)
  • string $uid: The user ID.
has (line 194)

Is the cache file relevant for the user?

  • return: True if the cache file is relevant.
boolean|PEAR_Error has (string $filename, string $uid)
  • string $filename: The cache file.
  • string $uid: The user ID.

Redefined in descendants as:
_add (line 156)

Set a cache file as relevant for a user.

  • return: True if successful.
boolean|PEAR_Error _add (string $filename, string $uid)
  • string $filename: The cache file to add.
  • string $uid: The user ID.
_close (line 111)

Close the database.

void _close ()
_notEmpty (line 244)

Check if the value is set.

  • return: True if the value is set.
boolean _notEmpty (mixed $value)
  • mixed $value: The value to check.
_open (line 94)

Open the database.

  • return: True if successful.
boolean|PEAR_Error _open ()
_remove (line 127)

Set a cache file as irrelevant for a user.

  • return: True if successful.
boolean|PEAR_Error _remove (string $filename, string $uid)
  • string $filename: The cache file to remove.
  • string $uid: The user ID.

Documentation generated on Sun, 10 Oct 2010 05:17:23 +0000 by phpDocumentor 1.4.3