ZF-2705: Implement Zend_Cache_Backend_Blackhole
Description
It'd be nice for components which rely on Zend_Cache to have a Blackhole backend which just pretends to cache data for unit testing, etc..
<?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 Backend
* @copyright Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
* @author John Coggeshall
*/
/**
* Zend_Cache_Backend_Interface
*/
require_once 'Zend/Cache/Backend/Interface.php';
/**
* Zend_Cache_Backend
*/
require_once 'Zend/Cache/Backend.php';
/**
* @package Zend_Cache
* @subpackage Backend
* @copyright Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
class Zend_Cache_Backend_Blackhole extends Zend_Cache_Backend implements Zend_Cache_Backend_Interface
{
/**
* Set the frontend directives
*
* @param array $directives assoc of directives
*/
public function setDirectives($directives)
{
/* ... - - - ... */
}
/**
* 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)
*
* @param string $id cache id
* @param boolean $doNotTestCacheValidity if set to true, the cache validity won't be tested
* @return string cached datas (or false)
*/
public function load($id, $doNotTestCacheValidity = false)
{
return false;
}
/**
* Test if a cache is available or not (for the given id)
*
* @param string $id cache id
* @return mixed false (a cache is not available) or "last modified" timestamp (int) of the available cache record
*/
public function test($id)
{
return false;
}
/**
* Save some string datas into a cache record
*
* Note : $data is always "string" (serialization is done by the
* core not by the backend)
*
* @param string $data datas to cache
* @param string $id cache id
* @param array $tags array of strings, the cache record will be tagged by each string entry
* @param int $specificLifetime if != false, set a specific lifetime for this cache record (null => infinite lifetime)
* @return boolean true if no problem
*/
public function save($data, $id, $tags = array(), $specificLifetime = false)
{
return true;
}
/**
* Remove a cache record
*
* @param string $id cache id
* @return boolean true if no problem
*/
public function remove($id)
{
return true;
}
/**
* 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)
*
* @param string $mode clean mode
* @param array $tags array of tags
* @return boolean true if no problem
*/
public function clean($mode = Zend_Cache::CLEANING_MODE_ALL, $tags = array())
{
return true;
}
}
Comments
Posted by Fabien MARTY (fab) on 2008-03-11T15:09:15.000+0000
what about the existing Test backend ? (used for unit tests)
Posted by Vincent de Lau (vdelau) on 2008-03-20T05:01:15.000+0000
I was browsing the issue tracker, because I need a simmilar backend although I would have named it Dummy.
I linked this to the custom frontend/backend issue, because the current implementation of Zend_Cache is not open to add such a backend without a drasctic subclassing of Zend_Cache or modifying Zend_Cache.
A Blackhole/Dummy backend is different from the Test backend: The Test backend returns data to be used in the unit tests. Implementing a custom backend selection method might help remove the requirement to to have this backend in the library. The Blackhole/Dummy backend is a backend that doesn't realy cache anything. It always generates a cache mis, and data is never stored. Caching can thus easily be disabled by simply changing the backend (for instance in a configuration file).
Posted by Fabien MARTY (fab) on 2008-04-04T17:32:55.000+0000
see http://framework.zend.com/issues/browse/ZF-2468
if you need this dummy backend ("caching" option of Core is probably a better solution ?), you can implement it at your side