API Documentation

Zend/Cache/Backend/ExtendedInterface.php

Show: inherited
    Table of Contents

    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.

    Category
    Zend  
    Copyright
    Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
    License
    New BSD License  
    Package
    Zend_Cache  
    Subpackage
    Zend_Cache_Backend  
    Version
    $Id: ExtendedInterface.php 24594 2012-01-05 21:27:01Z matthew $  

    \Zend_Cache_Backend_ExtendedInterface

    Package: Zend\Cache\Zend\Cache\Backend

    Parent(s)
    \Zend_Cache_Backend_Interface
    Copyright
    Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
    License
    New BSD License  

    Methods

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

    Returns
    Type Description
    array associative of with capabilities
    methodpublicgetFillingPercentage( ) : int

    Return the filling percentage of the backend storage

    Returns
    Type Description
    int integer between 0 and 100
    methodpublicgetIds( ) : array

    Return an array of stored cache ids

    Returns
    Type Description
    array array of stored cache ids (string)
    methodpublicgetIdsMatchingAnyTags( 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

    Parameters
    Name Type Description
    $tags array

    array of tags

    Returns
    Type Description
    array array of any matching cache ids (string)
    methodpublicgetIdsMatchingTags( 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

    Parameters
    Name Type Description
    $tags array

    array of tags

    Returns
    Type Description
    array array of matching cache ids (string)
    methodpublicgetIdsNotMatchingTags( 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

    Parameters
    Name Type Description
    $tags array

    array of tags

    Returns
    Type Description
    array array of not matching cache ids (string)
    methodpublicgetMetadatas( 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

    Parameters
    Name Type Description
    $id string

    cache id

    Returns
    Type Description
    array array of metadatas (false if the cache id is not found)
    methodpublicgetTags( ) : array

    Return an array of stored tags

    Returns
    Type Description
    array array of stored tags (string)
    methodpublictouch( string $id, int $extraLifetime ) : boolean

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

    Parameters
    Name Type Description
    $id string

    cache id

    $extraLifetime int
    Returns
    Type Description
    boolean true if ok
    Documentation was generated by DocBlox 0.15.1.