This class extends Cache_Lite and offers a cache system driven by a master file

With this class, cache validity is only dependent of a given file. Cache files are valid only if they are older than the master file. It's a perfect way for caching templates results (if the template file is newer than the cache, cache must be rebuild...) or for config classes... There are some examples in the 'docs/examples' file Technical choices are described in the 'docs/technical' file

• filesource: Source code for this file
• author: Fabien MARTY <[email protected]>
• version: $Id: File.php,v 1.3 2005/12/04 16:03:55 fab Exp $

Located in /pear/cache/lite/File.php (line 24)

 Cache_Lite

 Cache_Lite_File

string $_masterFile = '' (line 34)

Complete path of the file used for controlling the cache lifetime

int $_masterFile_mtime = 0 (line 41)

Masterfile mtime

Inherited Variables

Inherited from Cache_Lite

Cache_Lite::$_automaticCleaningFactor
Cache_Lite::$_automaticSerialization
Cache_Lite::$_cacheDir
Cache_Lite::$_caching
Cache_Lite::$_errorHandlingAPIBreak
Cache_Lite::$_file
Cache_Lite::$_fileLocking
Cache_Lite::$_fileName
Cache_Lite::$_fileNameProtection
Cache_Lite::$_group
Cache_Lite::$_hashedDirectoryLevel
Cache_Lite::$_hashedDirectoryUmask
Cache_Lite::$_id
Cache_Lite::$_lifeTime
Cache_Lite::$_memoryCaching
Cache_Lite::$_memoryCachingArray
Cache_Lite::$_memoryCachingCounter
Cache_Lite::$_memoryCachingLimit
Cache_Lite::$_onlyMemoryCaching
Cache_Lite::$_pearErrorMode
Cache_Lite::$_readControl
Cache_Lite::$_readControlType
Cache_Lite::$_refreshTime
Cache_Lite::$_writeControl

Constructor Cache_Lite_File (line 60)

Constructor

$options is an assoc. To have a look at availables options, see the constructor of the Cache_Lite class in 'Cache_Lite.php'

Comparing to Cache_Lite constructor, there is another option : $options = array( (...) see Cache_Lite constructor 'masterFile' => complete path of the file used for controlling the cache lifetime(string) );

• access: public

Cache_Lite_File Cache_Lite_File ([array $options = array(NULL)])

• array $options: options

get (line 82)

Test if a cache is available and (if yes) return it

• return: data of the cache (or false if no cache available)
• access: public

string get (string $id, [string $group = 'default'])

• string $id: cache id
• string $group: name of the cache group

---

Redefinition of:

Cache_Lite::get()

Test if a cache is available and (if yes) return it

Inherited Methods

Inherited From Cache_Lite

Cache_Lite::Cache_Lite()
Cache_Lite::clean()
Cache_Lite::extendLife()
Cache_Lite::get()
Cache_Lite::getMemoryCachingState()
Cache_Lite::lastModified()
Cache_Lite::raiseError()
Cache_Lite::remove()
Cache_Lite::save()
Cache_Lite::saveMemoryCachingState()
Cache_Lite::setLifeTime()
Cache_Lite::setOption()
Cache_Lite::setToDebug()