Docs For Class Zend_Cache_Backend

Zend_Cache_Backend_Sqlite

Description

Implements interfaces:

Zend_Cache_Backend_ExtendedInterface

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

Located in /Cache/Backend/Sqlite.php (line 40)

Zend_Cache_Backend
   |
   --Zend_Cache_Backend_Sqlite

Variable Summary

array $_options

Method Summary

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

void __destruct ()

boolean clean ([string $mode = Zend_Cache::CLEANING_MODE_ALL], [array $tags = array()])

array getCapabilities ()

int getFillingPercentage ()

array getIds ()

array getIdsMatchingAnyTags ([array $tags = array()])

array getIdsMatchingTags ([array $tags = array()])

array getIdsNotMatchingTags ([array $tags = array()])

array getMetadatas (string $id)

array getTags ()

string|false load (string $id, [boolean $doNotTestCacheValidity = false])

boolean remove (string $id)

boolean save (string $data, string $id, [array $tags = array()], [int $specificLifetime = false])

mixed|false test (string $id)

boolean touch (string $id, int $extraLifetime)

void ___expire (string $id)

Variables

array $_options = array(
'cache_db_complete_path' => null,
'automatic_vacuum_factor' => 10
) (line 58)

Available options

=====> (string) cache_db_complete_path :

the complete path (filename included) of the SQLITE database

====> (int) automatic_vacuum_factor :

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

throws: Zend_cache_Exception
access: public

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

array $options: Associative array of options

Redefinition of:

Zend_Cache_Backend::__construct(): Constructor

Destructor __destruct (line 101)

Destructor

access: public

void __destruct ()

clean (line 218)

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) Zend_Cache::CLEANING_MODE_MATCHING_ANY_TAG => remove cache entries matching any 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], [array $tags = array()])

string $mode: Clean mode
array $tags: Array of tags

Implementation of:

Zend_Cache_Backend_Interface::clean(): Clean some cache records

getCapabilities (line 456)

Return an associative array of capabilities (booleans) of the backend

The array must include these keys :

automatic_cleaning (is automating cleaning necessary)
tags (are tags supported)
expired_read (is it possible to read expired cache records (for doNotTestCacheValidity option for example))
priority does the backend deal with priority when saving
infinite_lifetime (is infinite lifetime can work with this backend)
get_list (is it possible to get the list of cache ids and the complete list of tags)

return: associative of with capabilities
access: public

array getCapabilities ()

Implementation of:

Zend_Cache_Backend_ExtendedInterface::getCapabilities(): Return an associative array of capabilities (booleans) of the backend

getFillingPercentage (line 369)

Return the filling percentage of the backend storage

return: integer between 0 and 100
throws: Zend_Cache_Exception
access: public

int getFillingPercentage ()

Implementation of:

Zend_Cache_Backend_ExtendedInterface::getFillingPercentage(): Return the filling percentage of the backend storage

getIds (line 231)

Return an array of stored cache ids

return: array of stored cache ids (string)
access: public

array getIds ()

Implementation of:

Zend_Cache_Backend_ExtendedInterface::getIds(): Return an array of stored cache ids

getIdsMatchingAnyTags (line 335)

Return an array of stored cache ids which match any given tags

In case of multiple tags, a logical AND is made between tags

return: array of any matching cache ids (string)
access: public

array getIdsMatchingAnyTags ([array $tags = array()])

array $tags: array of tags

Implementation of:

Zend_Cache_Backend_ExtendedInterface::getIdsMatchingAnyTags(): Return an array of stored cache ids which match any given tags

getIdsMatchingTags (line 266)

Return an array of stored cache ids which match given tags

In case of multiple tags, a logical AND is made between tags

return: array of matching cache ids (string)
access: public

array getIdsMatchingTags ([array $tags = array()])

array $tags: array of tags

Implementation of:

Zend_Cache_Backend_ExtendedInterface::getIdsMatchingTags(): Return an array of stored cache ids which match given tags

getIdsNotMatchingTags (line 302)

Return an array of stored cache ids which don't match given tags

In case of multiple tags, a logical OR is made between tags

return: array of not matching cache ids (string)
access: public

array getIdsNotMatchingTags ([array $tags = array()])

array $tags: array of tags

Implementation of:

Zend_Cache_Backend_ExtendedInterface::getIdsNotMatchingTags(): Return an array of stored cache ids which don't match given tags

getMetadatas (line 395)

Return an array of metadatas for the given cache id

The array must include these keys :

expire : the expire timestamp
tags : a string array of tags
mtime : timestamp of last modification time

return: array of metadatas (false if the cache id is not found)
access: public

array getMetadatas (string $id)

string $id: cache id

Implementation of:

Zend_Cache_Backend_ExtendedInterface::getMetadatas(): Return an array of metadatas for the given cache id

getTags (line 247)

Return an array of stored tags

return: array of stored tags (string)
access: public

array getTags ()

Implementation of:

Zend_Cache_Backend_ExtendedInterface::getTags(): Return an array of stored tags

load (line 113)

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

return: Cached datas
access: public

string|false load (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::load(): Test if a cache is available for the given id and (if yes) return it (false else)

remove (line 190)

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

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
throws: Zend_Cache_Exception
access: public

boolean save (string $data, string $id, [array $tags = array()], [int $specificLifetime = false])

string $data: Datas to cache
string $id: Cache id
array $tags: Array of strings, the cache record will be tagged by each string entry
int $specificLifetime: If != false, set a specific lifetime for this cache record (null => infinite lifetime)

Implementation of:

Zend_Cache_Backend_Interface::save(): Save some string datas into a cache record

test (line 134)

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

return: (a cache is not available) or "last modified" timestamp (int) of the available cache record
access: public

mixed|false 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)

touch (line 425)

Give (if possible) an extra lifetime to the given cache id

return: true if ok
access: public

boolean touch (string $id, int $extraLifetime)

string $id: cache id
int $extraLifetime

Implementation of:

Zend_Cache_Backend_ExtendedInterface::touch(): Give (if possible) an extra lifetime to the given cache id

___expire (line 475)

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::getLifetime()
Zend_Cache_Backend::getTmpDir()
Zend_Cache_Backend::isAutomaticCleaningAvailable()
Zend_Cache_Backend::setDirectives()
Zend_Cache_Backend::setOption()
Zend_Cache_Backend::_isGoodTmpDir()
Zend_Cache_Backend::_log()
Zend_Cache_Backend::_loggerSanity()

Documentation generated on Mon, 21 Jun 2010 15:46:12 -0400 by phpDocumentor 1.4.3