Class Horde_Kolab_FreeBusy_Cache_File_Vcal

Description

A cache file for complete free/busy information.

$Horde: framework/Kolab_FreeBusy/lib/Horde/Kolab/FreeBusy/Cache/File/Vcal.php,v 1.1.2.1 2010-10-10 16:26:44 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/File/Vcal.php (line 32)

Horde_Kolab_FreeBusy_Cache_File
   |
   --Horde_Kolab_FreeBusy_Cache_File_Vcal
Variable Summary
 string $_suffix
 int $_version
Method Summary
 Horde_Kolab_FreeBusy_Cache_File_Vcal __construct (string $cache_dir, boolean $extended, [int $min_age = 300], [int $max_age = 259200])
 boolean expired (Horde_Kolab_FreeBusy_Export_Freebusy_Combined $combined,  $extended, array $files, string $signature)
 boolean|PEAR_Error storeVcal (Horde_iCalendar $vcal, array $mtimes,  $signature)
Variables
string $_suffix = 'vc' (line 41)

The suffix of this cache file.

  • access: protected
int $_version = 3 (line 48)

Cache file version.

  • access: protected
Methods
Constructor __construct (line 81)

Construct the Horde_Kolab_FreeBusy_Cache_File_vcal instance.

  • access: public
Horde_Kolab_FreeBusy_Cache_File_Vcal __construct (string $cache_dir, boolean $extended, [int $min_age = 300], [int $max_age = 259200])
  • string $cache_dir: The path to the cache direcory.
  • boolean $extended: Does the cache hold extended data?
  • int $min_age: Minimum age in seconds before a cache file can be considered to be expired.
  • int $max_age: Maximum age in seconds after which a cache file is always considered to be expired.

Redefinition of:
Horde_Kolab_FreeBusy_Cache_File::__construct()
Construct the Horde_Kolab_FreeBusy_Cache_File instance.
expired (line 135)

Check if the cached free/busy expired.

  • return: True if the cached data expired.
boolean expired (Horde_Kolab_FreeBusy_Export_Freebusy_Combined $combined,  $extended, array $files, string $signature)
loadVcal (line 114)

Load the free/busy information from the cache.

Horde_iCalendar loadVcal ()
storeVcal (line 99)

Store free/busy infomation in the cache file.

  • return: True if successful.
boolean|PEAR_Error storeVcal (Horde_iCalendar $vcal, array $mtimes,  $signature)
  • Horde_iCalendar $vcal: A reference to the data object.
  • array $mtimes: A list of modification times for the partial free/busy cache times.
  • $signature

Inherited Methods

Inherited From Horde_Kolab_FreeBusy_Cache_File

 Horde_Kolab_FreeBusy_Cache_File::__construct()
 Horde_Kolab_FreeBusy_Cache_File::delete()
 Horde_Kolab_FreeBusy_Cache_File::getFile()
 Horde_Kolab_FreeBusy_Cache_File::getMtime()
 Horde_Kolab_FreeBusy_Cache_File::load()
 Horde_Kolab_FreeBusy_Cache_File::setFilename()
 Horde_Kolab_FreeBusy_Cache_File::setPartial()
 Horde_Kolab_FreeBusy_Cache_File::setSuffix()
 Horde_Kolab_FreeBusy_Cache_File::setVersion()
 Horde_Kolab_FreeBusy_Cache_File::store()

Documentation generated on Sun, 30 Jan 2011 05:23:09 +0000 by phpDocumentor 1.4.3