Docs For Class Zend_Cache_Backend_APC

## Class Zend_Cache_Backend_APC

Description

Implements interfaces:

- Zend_Cache_Backend_Interface

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

Located in /Zend/Cache/Backend/APC.php (line 40)

    Zend_Cache_Backend
       |
       --Zend_Cache_Backend_APC

Method Summary
Zend_Cache_Backend_APC __construct ([array $options = array()])
boolean clean ([string $mode = Zend_Cache::CLEANING_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()])
mixed test (string $id)
Variables

#### Inherited Variables

Inherited from Zend_Cache_Backend

> Zend_Cache_Backend::$_directives
> Zend_Cache_Backend::$_options

Methods
Constructor __construct (line 52)

Constructor

- access: public

Zend_Cache_Backend_APC __construct ([array $options = array()])

- array $options: associative array of options

Redefinition of:

Zend_Cache_Backend::__construct()
  Constructor

clean (line 146)

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 = Zend_Cache::CLEANING_MODE_ALL], [mixed $tags = array()])

- string $mode: clean mode

Implementation of:

Zend_Cache_Backend_Interface::clean()
  Clean some cache records

get (line 69)

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

WARNING $doNotTestCacheValidity=true is unsupported by the APC backend

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

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

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

test (line 89)

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)

#### Inherited Methods

Inherited From Zend_Cache_Backend

> Zend_Cache_Backend::__construct()
> Zend_Cache_Backend::setDirectives()
> Zend_Cache_Backend::setOption()

Documentation generated on Sun, 29 Oct 2006 21:27:00 -0600 by phpDocumentor 1.3.0RC6