Class Zend_Cache_Backend_File

Description

Implements interfaces:

  • license: New BSD License
  • copyright: Copyright (c) 2006 Zend Technologies USA Inc. (http://www.zend.com)

Located in /Zend/Cache/Backend/File.php (line 35)


	
			
Method Summary
 Zend_Cache_Backend_File __construct ([array $options = array()])
 boolean clean ([string $mode = 'all'], [mixed $tags = array()])
 string get (string $id, [boolean $doNotTestCacheValidity = false])
 boolean remove (string $id)
 boolean save (string $data, string $id, [array $tags = array()])
 void setDirectives (array $directives)
 void setOption (string $name, mixed $value)
 mixed test (string $id)
Methods
Constructor __construct (line 114)

Constructor

  • access: public
Zend_Cache_Backend_File __construct ([array $options = array()])
  • array $options: associative array of options
clean (line 302)

Clean some cache records

Available modes are : 'all' (default) => remove all cache entries ($tags is not used) 'old' => remove too old cache entries ($tags is not used) 'matchingTag' => remove cache entries matching all given tags ($tags can be an array of strings or a single string) 'notMatchingTag' => remove cache entries not matching one of the given tags ($tags can be an array of strings or a single string)

  • return: true if no problem
  • access: public
boolean clean ([string $mode = 'all'], [mixed $tags = array()])
  • string $mode: clean mode

Implementation of:
Zend_Cache_Backend_Interface::clean()
Clean some cache records
get (line 161)

Test if a cache is available for the given id and (if yes) return it (false else)

  • return: cached datas (or false)
  • access: public
string get (string $id, [boolean $doNotTestCacheValidity = false])
  • string $id: cache id
  • boolean $doNotTestCacheValidity: if set to true, the cache validity won't be tested

Implementation of:
Zend_Cache_Backend_Interface::get()
Test if a cache is available for the given id and (if yes) return it (false else)
remove (line 280)

Remove a cache record

  • return: true if no problem
  • access: public
boolean remove (string $id)
  • string $id: cache id

Implementation of:
Zend_Cache_Backend_Interface::remove()
Remove a cache record
save (line 234)

Save some string datas into a cache record

Note : $data is always "string" (serialization is done by the core not by the backend)

  • return: true if no problem
  • access: public
boolean save (string $data, string $id, [array $tags = array()])
  • string $data: datas to cache
  • string $id: cache id
  • array $tags: array of strings, the cache record will be tagged by each string entry

Implementation of:
Zend_Cache_Backend_Interface::save()
Save some string datas into a cache record
setDirectives (line 127)

Set the frontend directives

  • access: public
void setDirectives (array $directives)
  • array $directives: assoc of directives

Implementation of:
Zend_Cache_Backend_Interface::setDirectives()
Set the frontend directives
setOption (line 146)

Set an option

  • access: public
void setOption (string $name, mixed $value)
  • string $name
  • mixed $value
test (line 216)

Test if a cache is available or not (for the given id)

  • return: false (a cache is not available) or "last modified" timestamp (int) of the available cache record
  • access: public
mixed test (string $id)
  • string $id: cache id

Implementation of:
Zend_Cache_Backend_Interface::test()
Test if a cache is available or not (for the given id)

Documentation generated on Fri, 30 Jun 2006 11:20:31 -0500 by phpDocumentor 1.3.0RC6