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

Class: Cache_Lite_File

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

Class Overview

Cache_Lite
   |
   --Cache_Lite_File



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


[ Top ]


Method Detail

Cache_Lite_File (Constructor)   [line 55]

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

  • Access: public

Parameters:

array   $options     options

[ Top ]

get   [line 78]

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

Test if a cache is available and (if yes) return it
  • Return: data of the cache (else : false)
  • 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
boolean   $doNotTestCacheValidity     if set to true, the cache validity won't be tested

[ Top ]


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