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.3 2010/06/15 12:00:34 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
 array $_data
 int $_max_age
 int $_min_age
 string $_suffix
 int $_version
Method Summary
 Horde_Kolab_FreeBusy_Cache_File_vcal Horde_Kolab_FreeBusy_Cache_File_vcal (string $cache_dir, boolean $extended, [int $min_age = 300], [int $max_age = 259200])
 boolean|PEAR_Error expired (Horde_Kolab_FreeBusy_Export_Freebusy_Combined $combined,  $extended, array $files, string $signature)
 Horde_iCalendar|PEAR_Error &loadVcal ()
 boolean|PEAR_Error storeVcal (Horde_iCalendar $vcal, array $mtimes,  $signature)
Variables
array $_data (line 53)

Cached data.

int $_max_age (line 67)

Maximum age after which a cache file is always considered to be expired.

int $_min_age (line 60)

Minimum age before a cache file can be considered to be expired.

string $_suffix = 'vc' (line 39)

The suffix of this cache file.


Redefinition of:
Horde_Kolab_FreeBusy_Cache_File::$_suffix
The suffix of this cache file.
int $_version = 3 (line 46)

Cache file version.


Redefinition of:
Horde_Kolab_FreeBusy_Cache_File::$_version
Cache file version.

Inherited Variables

Inherited from Horde_Kolab_FreeBusy_Cache_File

Horde_Kolab_FreeBusy_Cache_File::$_file
Horde_Kolab_FreeBusy_Cache_File::$_filename
Methods
Constructor Horde_Kolab_FreeBusy_Cache_File_vcal (line 79)

Construct the Horde_Kolab_FreeBusy_Cache_File_vcal instance.

Horde_Kolab_FreeBusy_Cache_File_vcal Horde_Kolab_FreeBusy_Cache_File_vcal (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.
expired (line 137)

Check if the cached free/busy expired.

  • return: True if the cache expired.
boolean|PEAR_Error expired (Horde_Kolab_FreeBusy_Export_Freebusy_Combined $combined,  $extended, array $files, string $signature)
loadVcal (line 112)

Load the free/busy information from the cache.

  • return: The retrieved free/busy information.
Horde_iCalendar|PEAR_Error &loadVcal ()
storeVcal (line 97)

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::Horde_Kolab_FreeBusy_Cache_File()
 Horde_Kolab_FreeBusy_Cache_File::getFile()
 Horde_Kolab_FreeBusy_Cache_File::getFilename()
 Horde_Kolab_FreeBusy_Cache_File::load()
 Horde_Kolab_FreeBusy_Cache_File::purge()
 Horde_Kolab_FreeBusy_Cache_File::setFilename()
 Horde_Kolab_FreeBusy_Cache_File::store()
 Horde_Kolab_FreeBusy_Cache_File::_maketree()

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