Class Horde_Kolab_FreeBusy_Cache_File

A representation of a cache file.

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

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_File( string $cache_dir, string $filename, string $suffix = null )` Construct the Horde_Kolab_FreeBusy_Cache_File instance. Construct the Horde_Kolab_FreeBusy_Cache_File instance. Parameters `$cache_dir` The path to the cache direcory. `$filename` The file name of the cache file. `$suffix` The suffix of the cache file name.
`public string`	# `getFile( )` Get the full path to the cache file. Get the full path to the cache file. Returns `string` The full path to the file.
`public boolean\|PEAR_Error`	# `purge( )` Clean the cache file contents. Clean the cache file contents. Returns `boolean\|PEAR_Error` True if successful.
`public boolean\|PEAR_Error`	# `store( mixed & $data )` Store data in the cache file. Store data in the cache file. Parameters `$data` A reference to the data object. Returns `boolean\|PEAR_Error` True if successful.
`public mixed\|PEAR_Error &`	# `load( )` Load data from the cache file. Load data from the cache file. Returns `mixed\|PEAR_Error` The data retrieved from the cache file.
`public boolean\|PEAR_Error`	# `_maketree( string $dirname )` Generate a tree of directories. Generate a tree of directories. Parameters `$dirname` The path to a directory that should exist. Returns `boolean\|PEAR_Error` True if successful.

Properties summary
`public string`	`$_suffix` The suffix of this cache file. The suffix of this cache file.	# `''`
`public string`	`$_filename` Name of the cache file. Name of the cache file.	#
`public string`	`$_file` Full path to the cache file. Full path to the cache file.	#
`public integer`	`$_version` Cache file version. Cache file version.	# `1`

`public`	# `Horde_Kolab_FreeBusy_Cache_File( string $cache_dir, string $filename, string $suffix = null )` Construct the Horde_Kolab_FreeBusy_Cache_File instance. Construct the Horde_Kolab_FreeBusy_Cache_File instance. Parameters `$cache_dir` The path to the cache direcory. `$filename` The file name of the cache file. `$suffix` The suffix of the cache file name.
`public string`	# `getFile( )` Get the full path to the cache file. Get the full path to the cache file. Returns `string` The full path to the file.
`public boolean\|PEAR_Error`	# `purge( )` Clean the cache file contents. Clean the cache file contents. Returns `boolean\|PEAR_Error` True if successful.
`public boolean\|PEAR_Error`	# `store( mixed & $data )` Store data in the cache file. Store data in the cache file. Parameters `$data` A reference to the data object. Returns `boolean\|PEAR_Error` True if successful.
`public mixed\|PEAR_Error &`	# `load( )` Load data from the cache file. Load data from the cache file. Returns `mixed\|PEAR_Error` The data retrieved from the cache file.
`public boolean\|PEAR_Error`	# `_maketree( string $dirname )` Generate a tree of directories. Generate a tree of directories. Parameters `$dirname` The path to a directory that should exist. Returns `boolean\|PEAR_Error` True if successful.