Class Horde_Kolab_FreeBusy_Cache_File

Description

A representation of a cache file.

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


	
			
Direct descendents
Class Description
 class Horde_Kolab_FreeBusy_Cache_File_Acl A cache file for ACLs. This serves as a buffer between the DB based ACL storage and is required to hold the old ACL list for updates to the DB based cache.
 class Horde_Kolab_FreeBusy_Cache_File_Pvcal A cache file for partial free/busy information.
 class Horde_Kolab_FreeBusy_Cache_File_Vcal A cache file for complete free/busy information.
 class Horde_Kolab_FreeBusy_Cache_File_Xacl A cache file for extended ACLs. This serves as a buffer between the DB based ACL storage and is required to hold the old ACL list for updates to the DB based cache.
Method Summary
 Horde_Kolab_FreeBusy_Cache_File __construct (string $cache_dir, string $suffix)
 NULL delete ()
 string getFile ()
 int getMtime ()
 mixed load ()
 NULL setFilename (string $filename)
 NULL setSuffix (string $suffix)
 NULL setVersion (int $version)
 NULL store ( &$data, mixed $data)
Methods
Constructor __construct (line 61)

Construct the Horde_Kolab_FreeBusy_Cache_File instance.

  • access: public
Horde_Kolab_FreeBusy_Cache_File __construct (string $cache_dir, string $suffix)
  • string $cache_dir: The path to the cache direcory.
  • string $suffix: The suffix of the cache file name.

Redefined in descendants as:
delete (line 144)

Clean the cache file contents.

  • throws: Horde_Kolab_FreeBusy_Exception In case cleaning the cache file failed.
  • access: public
NULL delete ()
getFile (line 126)

Get the full path to the cache file.

  • return: The full path to the file.
  • access: public
string getFile ()
getMtime (line 262)

Return the last modification date of the cache file.

  • return: The last modification date.
  • access: public
int getMtime ()
load (line 204)

Load data from the cache file.

  • return: The data retrieved from the cache file.
  • throws: Horde_Kolab_FreeBusy_Exception In case reading the cached data failed.
  • access: public
mixed load ()
setFilename (line 111)

Set the full path to the cache file.

  • access: public
NULL setFilename (string $filename)
  • string $filename: The file name of the cache file.
setPartial (line 98)

Set the partial represented by this cache file.

  • access: public
NULL setPartial (Horde_Kolab_FreeBusy_Cache_Partial $partial)
setSuffix (line 74)

Set the cache file suffix.

  • access: protected
NULL setSuffix (string $suffix)
  • string $suffix: The suffix.
setVersion (line 86)

Set the version expected for the cached data.

  • access: protected
NULL setVersion (int $version)
  • int $version: The version number.
store (line 168)

Store data in the cache file.

  • throws: Horde_Kolab_FreeBusy_Exception In case storing the data failed.
  • access: public
NULL store ( &$data, mixed $data)
  • mixed $data: A reference to the data object.
  • &$data

Documentation generated on Sun, 30 Jan 2011 05:17:19 +0000 by phpDocumentor 1.4.3