Cache/Backend/Sqlite.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Cache
subpackage: Zend_Cache_Backend
version: $Id: Sqlite.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Cache_Backend_Sqlite

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Cache_Backend_Sqlite
jump to top

Extends from: Zend_Cache_Backend
Implements: Zend_Cache_Backend_ExtendedInterface
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Cache
subpackage: Zend_Cache_Backend
Properties: $_options; $_db; $_structureChecked
Methods: __construct; __destruct; load; test; save; remove; clean; getIds; getTags; getIdsMatchingTags; getIdsNotMatchingTags; getIdsMatchingAnyTags; getFillingPercentage; getMetadatas; touch; getCapabilities; ___expire; _getConnection; _query; _automaticVacuum; _registerTag; _buildStructure; _checkStructureVersion; _clean; _checkAndBuildStructure

Description

Properties

$_db
jump to class

mixed $_db = 'null'

DB ressource

Details

$_db: mixed
visibility: private
default: null
final: false
static: false

$_options
jump to class

array $_options = 'array'

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

Details

$_options: array
Available options
visibility: protected
default: array
final: false
static: false

$_structureChecked
jump to class

boolean $_structureChecked = 'false'

Boolean to store if the structure has benn checked or not

Details

$_structureChecked: boolean
visibility: private
default: false
final: false
static: false

Methods

___expire
jump to class

___expire(
          string $id
          )
        
        :

PUBLIC METHOD FOR UNIT TESTING ONLY !

Force a cache record to expire

Arguments

$id: string
Cache id

Details

visibility: public
final: false
static: false

__construct
jump to class

__construct(
          array $options
              =
              array
          )
        
        :
        void

Constructor

Arguments

$options: array
Associative array of options

Details

visibility: public
final: false
static: false
throws

__destruct
jump to class

__destruct(
          
          )
        
        :
        void

Destructor

Details

visibility: public
final: false
static: false

_automaticVacuum
jump to class

_automaticVacuum(
          
          )
        
        :
        void

Deal with the automatic vacuum process

Details

visibility: private
final: false
static: false

_buildStructure
jump to class

_buildStructure(
          
          )
        
        :
        false

Build the database structure

Output

false

Details

visibility: private
final: false
static: false

_checkAndBuildStructure
jump to class

_checkAndBuildStructure(
          
          )
        
        :
        boolean

Check if the database structure is ok (with the good version), if no : build it

Output

boolean: True if ok

Details

visibility: private
final: false
static: false
throws

_checkStructureVersion
jump to class

_checkStructureVersion(
          
          )
        
        :
        boolean

Check if the database structure is ok (with the good version)

Output

boolean: True if ok

Details

visibility: private
final: false
static: false

_clean
jump to class

_clean(
          string $mode
              =
              Zend_Cache, array $tags
              =
              array
          )
        
        :
        boolean

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)

Arguments

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

Output

boolean: True if no problem

Details

visibility: private
final: false
static: false

_getConnection
jump to class

_getConnection(
          
          )
        
        :
        resource

Return the connection resource

If we are not connected, the connection is made

Output

resource: Connection resource

Details

visibility: private
final: false
static: false
throws

_query
jump to class

_query(
          string $query
          )
        
        :
        mixed|false

Execute an SQL query silently

Arguments

$query: string
SQL query

Output

mixed|false: query results

Details

visibility: private
final: false
static: false

_registerTag
jump to class

_registerTag(
          string $id, string $tag
          )
        
        :
        boolean

Arguments

$id: string
Cache id
$tag: string
Tag

Output

boolean: True if no problem

Details

visibility: private
final: false
static: false

clean
jump to class

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

Clean some cache records

Arguments

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

Output

boolean: True if no problem

Details

visibility: public
final: false
static: false

getCapabilities
jump to class

getCapabilities(
          
          )
        
        :
        array

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)

Output

array: associative of with capabilities

Details

visibility: public
final: false
static: false

getFillingPercentage
jump to class

getFillingPercentage(
          
          )
        
        :
        int

Return the filling percentage of the backend storage

Output

int: integer between 0 and 100

Details

visibility: public
final: false
static: false
throws

getIds
jump to class

getIds(
          
          )
        
        :
        array

Return an array of stored cache ids

Output

array: array of stored cache ids (string)

Details

visibility: public
final: false
static: false

getIdsMatchingAnyTags
jump to class

getIdsMatchingAnyTags(
          array $tags
              =
              array
          )
        
        :
        array

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

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

Arguments

$tags: array
array of tags

Output

array: array of any matching cache ids (string)

Details

visibility: public
final: false
static: false

getIdsMatchingTags
jump to class

getIdsMatchingTags(
          array $tags
              =
              array
          )
        
        :
        array

Return an array of stored cache ids which match given tags

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

Arguments

$tags: array
array of tags

Output

array: array of matching cache ids (string)

Details

visibility: public
final: false
static: false

getIdsNotMatchingTags
jump to class

getIdsNotMatchingTags(
          array $tags
              =
              array
          )
        
        :
        array

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

Arguments

$tags: array
array of tags

Output

array: array of not matching cache ids (string)

Details

visibility: public
final: false
static: false

getMetadatas
jump to class

getMetadatas(
          string $id
          )
        
        :
        array

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

Arguments

$id: string
cache id

Output

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

Details

visibility: public
final: false
static: false

getTags
jump to class

getTags(
          
          )
        
        :
        array

Return an array of stored tags

Output

array: array of stored tags (string)

Details

visibility: public
final: false
static: false

load
jump to class

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

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

Arguments

$id: string
Cache id
$doNotTestCacheValidity: boolean
If set to true, the cache validity won't be tested

Output

string|false: Cached datas

Details

visibility: public
final: false
static: false

remove
jump to class

remove(
          string $id
          )
        
        :
        boolean

Remove a cache record

Arguments

$id: string
Cache id

Output

boolean: True if no problem

Details

visibility: public
final: false
static: false

save
jump to class

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

Save some string datas into a cache record

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

Arguments

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

Output

boolean: True if no problem

Details

visibility: public
final: false
static: false
throws

test
jump to class

test(
          string $id
          )
        
        :
        mixed|false

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

Arguments

$id: string
Cache id

Output

mixed|false: (a cache is not available) or "last modified" timestamp (int) of the available cache record

Details

visibility: public
final: false
static: false

touch
jump to class

touch(
          string $id, int $extraLifetime
          )
        
        :
        boolean

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

Arguments

$id: string
cache id
$extraLifetime: int

Output

boolean: true if ok

Details

visibility: public
final: false
static: false

API Documentation

Cache/Backend/Sqlite.php

Description

Zend_Cache_Backend_Sqlitejump to top

Description

Properties

$_dbjump to class

Details

$_optionsjump to class

Details

$_structureCheckedjump to class

Details

Methods

___expirejump to class

Arguments

Details

__constructjump to class

Arguments

Details

__destructjump to class

Details

_automaticVacuumjump to class

Details

_buildStructurejump to class

Output

Details

_checkAndBuildStructurejump to class

Output

Details

_checkStructureVersionjump to class

Output

Details

_cleanjump to class

Arguments

Output

Details

_getConnectionjump to class

Output

Details

_queryjump to class

Arguments

Output

Details

_registerTagjump to class

Arguments

Output

Details

cleanjump to class

Arguments

Output

Details

getCapabilitiesjump to class

Output

Details

getFillingPercentagejump to class

Output

Details

getIdsjump to class

Output

Details

getIdsMatchingAnyTagsjump to class

Arguments

Output

Details

getIdsMatchingTagsjump to class

Arguments

Output

Details

getIdsNotMatchingTagsjump to class

Arguments

Output

Details

getMetadatasjump to class

Arguments

Output

Details

getTagsjump to class

Output

Details

loadjump to class

Zend_Cache_Backend_Sqlite
jump to top

$_db
jump to class

$_options
jump to class

$_structureChecked
jump to class

___expire
jump to class

__construct
jump to class

__destruct
jump to class

_automaticVacuum
jump to class

_buildStructure
jump to class

_checkAndBuildStructure
jump to class

_checkStructureVersion
jump to class

_clean
jump to class

_getConnection
jump to class

_query
jump to class

_registerTag
jump to class

clean
jump to class

getCapabilities
jump to class

getFillingPercentage
jump to class

getIds
jump to class

getIdsMatchingAnyTags
jump to class

getIdsMatchingTags
jump to class

getIdsNotMatchingTags
jump to class

getMetadatas
jump to class

getTags
jump to class

load
jump to class

remove
jump to class

save
jump to class

test
jump to class

touch
jump to class