Class Horde_Kolab_FreeBusy_Cache_DB

A berkeley db based cache for free/busy data.

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Direct known subclasses

Horde_Kolab_FreeBusy_Cache_DB_acl, Horde_Kolab_FreeBusy_Cache_DB_xacl

Package: Kolab\FreeBusy
Author: Gunnar Wrobel p@rdus.de
Author: Steffen Hansen steffen@klaralvdalens-datakonsult.se
Located at Horde/Kolab/FreeBusy/Cache.php

Methods summary
`public`	# `Horde_Kolab_FreeBusy_Cache_DB( mixed $cache_dir )` The directory that should be used for caching. The directory that should be used for caching. Var string
`public boolean\|PEAR_Error`	# `_open( )` Open the database. Open the database. Returns `boolean\|PEAR_Error` True if successful.
`public`	# `_close( )` Close the database. Close the database.
`public boolean\|PEAR_Error`	# `_remove( string $filename, string $uid )` Set a cache file as irrelevant for a user. Set a cache file as irrelevant for a user. Parameters `$filename` The cache file to remove. `$uid` The user ID. Returns `boolean\|PEAR_Error` True if successful.
`public boolean\|PEAR_Error`	# `_add( string $filename, string $uid )` Set a cache file as relevant for a user. Set a cache file as relevant for a user. Parameters `$filename` The cache file to add. `$uid` The user ID. Returns `boolean\|PEAR_Error` True if successful.
`public boolean\|PEAR_Error`	# `has( string $filename, string $uid )` Is the cache file relevant for the user? Is the cache file relevant for the user? Parameters `$filename` The cache file. `$uid` The user ID. Returns `boolean\|PEAR_Error` True if the cache file is relevant.
`public array\|PEAR_Error`	# `get( string $uid )` Get the full list of relevant cache files for a uid. Get the full list of relevant cache files for a uid. Parameters `$uid` The user ID. Returns `array\|PEAR_Error` The list of cache files.
`public boolean`	# `_notEmpty( mixed $value )` Check if the value is set. Check if the value is set. Parameters `$value` The value to check. Returns `boolean` True if the value is set.
`public FreeBusyACLCache &`	# `singleton( string $type, string $cache_dir )` Attempts to return a reference to a concrete FreeBusyACLCache instance. It will only create a new instance if no FreeBusyACLCache instance currently exists. 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: $var = &FreeBusyACLCache::singleton($cache_dir); Parameters `$type` The type of the cache. `$cache_dir` The directory for storing the cache. Returns `FreeBusyACLCache` The concrete FreeBusyACLCache reference, or false on an error.

Properties summary
`public string`	`$_cache_dir` The directory that should be used for caching. The directory that should be used for caching.	#
`public resource`	`$_db` The resource handle into the database. The resource handle into the database.	# `false`
`public string`	`$_dbformat` The format of the database. The format of the database.	#
`public string`	`$_type` The type of this cache. The type of this cache.	# `''`

`public`	# `Horde_Kolab_FreeBusy_Cache_DB( mixed $cache_dir )` The directory that should be used for caching. The directory that should be used for caching. Var string
`public boolean\|PEAR_Error`	# `_open( )` Open the database. Open the database. Returns `boolean\|PEAR_Error` True if successful.
`public`	# `_close( )` Close the database. Close the database.
`public boolean\|PEAR_Error`	# `_remove( string $filename, string $uid )` Set a cache file as irrelevant for a user. Set a cache file as irrelevant for a user. Parameters `$filename` The cache file to remove. `$uid` The user ID. Returns `boolean\|PEAR_Error` True if successful.
`public boolean\|PEAR_Error`	# `_add( string $filename, string $uid )` Set a cache file as relevant for a user. Set a cache file as relevant for a user. Parameters `$filename` The cache file to add. `$uid` The user ID. Returns `boolean\|PEAR_Error` True if successful.
`public boolean\|PEAR_Error`	# `has( string $filename, string $uid )` Is the cache file relevant for the user? Is the cache file relevant for the user? Parameters `$filename` The cache file. `$uid` The user ID. Returns `boolean\|PEAR_Error` True if the cache file is relevant.
`public array\|PEAR_Error`	# `get( string $uid )` Get the full list of relevant cache files for a uid. Get the full list of relevant cache files for a uid. Parameters `$uid` The user ID. Returns `array\|PEAR_Error` The list of cache files.
`public boolean`	# `_notEmpty( mixed $value )` Check if the value is set. Check if the value is set. Parameters `$value` The value to check. Returns `boolean` True if the value is set.
`public FreeBusyACLCache &`	# `singleton( string $type, string $cache_dir )` Attempts to return a reference to a concrete FreeBusyACLCache instance. It will only create a new instance if no FreeBusyACLCache instance currently exists. 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: $var = &FreeBusyACLCache::singleton($cache_dir); Parameters `$type` The type of the cache. `$cache_dir` The directory for storing the cache. Returns `FreeBusyACLCache` The concrete FreeBusyACLCache reference, or false on an error.

Packages

Classes

Interfaces

Class Horde_Kolab_FreeBusy_Cache_DB

Direct known subclasses

Var

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns