Cache/Backend/ExtendedInterface.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: ExtendedInterface.php 20096 2010-01-06 02:05:09Z bkarwin $
Interfaces: Zend_Cache_Backend_ExtendedInterface

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

Extends from: Zend_Cache_Backend_Interface
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: getIds; getTags; getIdsMatchingTags; getIdsNotMatchingTags; getIdsMatchingAnyTags; getFillingPercentage; getMetadatas; touch; getCapabilities

Description

Methods

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

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

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/ExtendedInterface.php

Description

Zend_Cache_Backend_ExtendedInterfacejump to top

Description

Methods

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

touchjump to class

Arguments

Output

Details

Zend_Cache_Backend_ExtendedInterface
jump to top

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

touch
jump to class