128 lines
4.0 KiB
PHP
128 lines
4.0 KiB
PHP
<?php
|
|
/**
|
|
* 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
|
|
* @package Zend_Cache
|
|
* @subpackage Zend_Cache_Backend
|
|
* @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
|
|
* @license http://framework.zend.com/license/new-bsd New BSD License
|
|
* @version $Id: ExtendedInterface.php 24593 2012-01-05 20:35:02Z matthew $
|
|
*/
|
|
|
|
/**
|
|
* @see Zend_Cache_Backend_Interface
|
|
*/
|
|
//require_once 'Zend/Cache/Backend/Interface.php';
|
|
require_once dirname(__FILE__).'/Interface.php';
|
|
|
|
/**
|
|
* @package Zend_Cache
|
|
* @subpackage Zend_Cache_Backend
|
|
* @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
|
|
* @license http://framework.zend.com/license/new-bsd New BSD License
|
|
*/
|
|
interface Zend_Cache_Backend_ExtendedInterface extends Zend_Cache_Backend_Interface
|
|
{
|
|
|
|
/**
|
|
* Return an array of stored cache ids
|
|
*
|
|
* @return array array of stored cache ids (string)
|
|
*/
|
|
public function getIds();
|
|
|
|
/**
|
|
* Return an array of stored tags
|
|
*
|
|
* @return array array of stored tags (string)
|
|
*/
|
|
public function getTags();
|
|
|
|
/**
|
|
* Return an array of stored cache ids which match given tags
|
|
*
|
|
* In case of multiple tags, a logical AND is made between tags
|
|
*
|
|
* @param array $tags array of tags
|
|
* @return array array of matching cache ids (string)
|
|
*/
|
|
public function getIdsMatchingTags($tags = 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
|
|
*
|
|
* @param array $tags array of tags
|
|
* @return array array of not matching cache ids (string)
|
|
*/
|
|
public function getIdsNotMatchingTags($tags = 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
|
|
*
|
|
* @param array $tags array of tags
|
|
* @return array array of any matching cache ids (string)
|
|
*/
|
|
public function getIdsMatchingAnyTags($tags = array());
|
|
|
|
/**
|
|
* Return the filling percentage of the backend storage
|
|
*
|
|
* @return int integer between 0 and 100
|
|
*/
|
|
public function getFillingPercentage();
|
|
|
|
/**
|
|
* 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
|
|
*
|
|
* @param string $id cache id
|
|
* @return array array of metadatas (false if the cache id is not found)
|
|
*/
|
|
public function getMetadatas($id);
|
|
|
|
/**
|
|
* Give (if possible) an extra lifetime to the given cache id
|
|
*
|
|
* @param string $id cache id
|
|
* @param int $extraLifetime
|
|
* @return boolean true if ok
|
|
*/
|
|
public function touch($id, $extraLifetime);
|
|
|
|
/**
|
|
* 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)
|
|
*
|
|
* @return array associative of with capabilities
|
|
*/
|
|
public function getCapabilities();
|
|
|
|
}
|