Class: Cache_Lite_File

Source Location: /pear/Cache/Lite/File.php

Class Overview

Cache_Lite
   |
   --Cache_Lite_File

Inherited Variables

Class: 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

Inherited Methods

Class: Cache_Lite

Cache_Lite::Cache_Lite(): Constructor
Cache_Lite::clean(): Clean the cache
Cache_Lite::extendLife(): Extend the life of a valid cache file
Cache_Lite::get(): Test if a cache is available and (if yes) return it
Cache_Lite::getMemoryCachingState(): Load the state of the caching memory array from a given cache file cache
Cache_Lite::lastModified(): Return the cache last modification time
Cache_Lite::raiseError(): Trigger a PEAR error
Cache_Lite::remove(): Remove a cache file
Cache_Lite::save(): Save some data in a cache file
Cache_Lite::saveMemoryCachingState(): Save the state of the caching memory array into a cache file cache
Cache_Lite::setLifeTime(): Set a new life time
Cache_Lite::setOption(): Generic way to set a Cache_Lite option
Cache_Lite::setToDebug(): Set to debug mode

Class Details

[line 20]

[ Top ]

Class Variables

$_masterFile = ''

[line 30]

Complete path of the file used for controlling the cache lifetime

Type:

string

[ Top ]

$_masterFile_mtime = 0

[line 37]

Masterfile mtime

Type:

int

[ Top ]

Class Methods

constructor Cache_Lite_File [line 56]

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

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) );

Tags:

access:

public

Parameters:

array

$options

options

[ Top ]

method get [line 78]

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

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

Tags:

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

Overrides Cache_Lite::get() (Test if a cache is available and (if yes) return it)

Parameters:

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

[ Top ]

Documentation generated on Sun, 08 Jan 2012 17:51:47 +0100 by phpDocumentor 1.4.3