apidoc
[ class tree: apidoc ] [ index: apidoc ] [ all elements ]

Class: Cache_Lite_Function

Source Location: /Cache_Lite-1.7.15/Cache/Lite/Function.php

Class Overview

Cache_Lite
   |
   --Cache_Lite_Function



Methods


Inherited Variables

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 ]


Method Detail

Cache_Lite_Function (Constructor)   [line 84]

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

  • Access: public

Parameters:

array   $options     options

[ Top ]

call   [line 108]

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

  • Return: result of the function/method
  • Access: public

[ Top ]

drop   [line 184]

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

  • Return: true if no problem
  • Access: public

[ Top ]


Documentation generated on Thu, 24 May 2012 08:00:02 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.