This class extends Cache_Lite and can be used to cache the result and output of functions/methods

This class is completly inspired from Sebastian Bergmann's PEAR/Cache_Function class. This is only an adaptation to Cache_Lite

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: Sebastian BERGMANN <[email protected]>
• author: Fabien MARTY <[email protected]>
• version: $Id: Function.php,v 1.10 2006/02/04 18:36:36 fab Exp $

Located in /pear/cache/lite/Function.php (line 25)

 Cache_Lite

 Cache_Lite_Function

boolean $_debugCacheLiteFunction = false (line 66)

Debug the Cache_Lite_Function caching process

string $_defaultGroup = 'Cache_Lite_Function' (line 35)

Default cache group for function caching

boolean $_dontCacheWhenTheOutputContainsNOCACHE = false (line 45)

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)

boolean $_dontCacheWhenTheResultIsFalse = false (line 52)

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

boolean $_dontCacheWhenTheResultIsNull = false (line 59)

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

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_Function (line 89)

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

• access: public

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

• array $options: options

call (line 113)

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

• return: result of the function/method
• access: public

mixed call ()

drop (line 189)

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

• return: true if no problem
• access: public

boolean drop ()

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