Docs For Class Zend_Cache_Backend_Sqlite

## Class Zend_Cache_Backend_Sqlite

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/Sqlite.php (line 39)

    Zend_Cache_Backend
       |
       --Zend_Cache_Backend_Sqlite

Variable Summary
array $_options
Method Summary
Zend_Cache_Backend_Sqlite __construct ([array $options = array()])
void __destruct ()
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)
void ___dropDatabaseFile ()
void ___expire (string $id)
Variables
array $_options = array(
'cacheDBCompletePath' => null,
'automaticVacuumFactor' => 0
) (line 62)

Available options

=====> (string) cacheDBCompletePath :

- the complete path (filename included) of the SQLITE database

====> (int) automaticVacuumFactor :

- Disable / Tune the automatic vacuum process
- The automatic vacuum process defragment the database file (and make it smaller) when a clean() or delete() is called 0 => no automatic vacuum 1 => systematic vacuum (when delete() or clean() methods are called) x (integer) > 1 => automatic vacuum randomly 1 times on x clean() or delete()

- var: available options
- access: protected

Redefinition of:

Zend_Cache_Backend::$_options
  Available options

#### Inherited Variables

Inherited from Zend_Cache_Backend

> Zend_Cache_Backend::$_directives

Methods
Constructor __construct (line 84)

Constructor

- access: public

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

- array $options: associative array of options

Redefinition of:

Zend_Cache_Backend::__construct()
  Constructor

Destructor __destruct (line 97)

Destructor

- access: public

void __destruct ()
clean (line 213)

Clean some cache records

Available modes are : Zend_Cache::CLEANING_MODE_ALL (default) => remove all cache entries ($tags is not used) Zend_Cache::CLEANING_MODE_OLD => remove too old cache entries ($tags is not used) Zend_Cache::CLEANING_MODE_MATCHING_TAG => remove cache entries matching all given tags ($tags can be an array of strings or a single string) Zend_Cache::CLEANING_MODE_NOT_MATCHING_TAG => 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 109)

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

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

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

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)

___dropDatabaseFile (line 238)

PUBLIC METHOD FOR UNIT TESTING ONLY !

Unlink the database file

- access: public

void ___dropDatabaseFile ()
___expire (line 227)

PUBLIC METHOD FOR UNIT TESTING ONLY !

Force a cache record to expire

- access: public

void ___expire (string $id)

- string $id: cache 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:32 -0600 by phpDocumentor 1.3.0RC6