Class: Cache_Lite_Function

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

Class Overview

Cache_Lite
   |
   --Cache_Lite_Function

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 21]

[ Top ]

Class Variables

$_debugCacheLiteFunction = false

[line 62]

Debug the Cache_Lite_Function caching process

Type:

boolean

[ Top ]

$_defaultGroup = 'Cache_Lite_Function'

[line 31]

Default cache group for function caching

Type:

string

[ Top ]

$_dontCacheWhenTheOutputContainsNOCACHE = false

[line 41]

Don't cache the method call when its output contains the string "NOCACHE"

if set to true, the output of the method will never be displayed (because the output is used to control the cache)

Type:

boolean

[ Top ]

$_dontCacheWhenTheResultIsFalse = false

[line 48]

Don't cache the method call when its result is false

Type:

boolean

[ Top ]

$_dontCacheWhenTheResultIsNull = false

[line 55]

Don't cache the method call when its result is null

Type:

boolean

[ Top ]

Class Methods

constructor Cache_Lite_Function [line 85]

Cache_Lite_Function Cache_Lite_Function(
[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 'debugCacheLiteFunction' => (bool) debug the caching process, 'defaultGroup' => default cache group for function caching (string), 'dontCacheWhenTheOutputContainsNOCACHE' => (bool) don't cache when the function output contains "NOCACHE", 'dontCacheWhenTheResultIsFalse' => (bool) don't cache when the function result is false, 'dontCacheWhenTheResultIsNull' => (bool don't cache when the function result is null );

Tags:

access:

public

Parameters:

array

$options

options

[ Top ]

method call [line 109]

mixed call(
)

Calls a cacheable function or method (or not if there is already a cache for it)

Arguments of this method are read with func_get_args. So it doesn't appear in the function definition. Synopsis : call('functionName', $arg1, $arg2, ...) (arg1, arg2... are arguments of 'functionName')

Tags:

return:	result of the function/method
access:	public

[ Top ]

method drop [line 185]

boolean drop(
)

Drop a cache file

Arguments of this method are read with func_get_args. So it doesn't appear in the function definition. Synopsis : remove('functionName', $arg1, $arg2, ...) (arg1, arg2... are arguments of 'functionName')

Tags:

return:	true if no problem
access:	public

[ Top ]

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