API Documentation

Zend/Cache/Backend/Interface.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: Interface.php 24594 2012-01-05 21:27:01Z matthew $  

    \Zend_Cache_Backend_Interface

    Package: Zend\Cache\Zend\Cache\Backend

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

    Methods

    methodpublicclean( string $mode = Zend_Cache::CLEANING_MODE_ALL, 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)

    Parameters
    Name Type Description
    $mode string

    Clean mode

    $tags array

    Array of tags

    Returns
    Type Description
    boolean true if no problem
    methodpublicload( 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)

    Parameters
    Name Type Description
    $id string

    Cache id

    $doNotTestCacheValidity boolean

    If set to true, the cache validity won't be tested

    Returns
    Type Description
    string|false cached datas
    methodpublicremove( string $id ) : boolean

    Remove a cache record

    Parameters
    Name Type Description
    $id string

    Cache id

    Returns
    Type Description
    boolean True if no problem
    methodpublicsave( 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)

    Parameters
    Name Type Description
    $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)

    Returns
    Type Description
    boolean true if no problem
    methodpublicsetDirectives( array $directives ) : void

    Set the frontend directives

    Parameters
    Name Type Description
    $directives array

    assoc of directives

    methodpublictest( string $id ) : mixed|false

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

    Parameters
    Name Type Description
    $id string

    cache id

    Returns
    Type Description
    mixed|false (a cache is not available) or "last modified" timestamp (int) of the available cache record
    Documentation was generated by DocBlox 0.15.1.