API Documentation

Cache/Backend/Interface.php

Interfaces
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: Interface.php 20096 2010-01-06 02:05:09Z bkarwin $
Interfaces
Zend_Cache_Backend_Interface

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_Interface
jump to top

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
Methods
setDirectives
load
test
save
remove
clean

Description

Methods

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

Note : return value is always "string" (unserialization is done by the core not by the backend)

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

setDirectives
jump to class

setDirectives( array $directives ) :

Set the frontend directives

Arguments
$directives
array
assoc of directives
Details
visibility
public
final
false
static
false

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
Documentation was generated by DocBlox.