这是一个轻量级、简单但功能强大的 PHP5 缓存类,它使用文件系统进行缓存。
A light, simple but powerful PHP5 Cache Class which uses the filesystem for caching.
Your feedback is always welcome.
Basically the caching class stores its data in files in the JSON format. These files will be created if you store data under a Cache name.
If you set a new Cache name with setCache(), a new cache file will be generated. The Cache will store all further data in the new file. The Setter method allows you to switch between the different Cache files.
It's not much trouble to setup the Cache.
First create a writable directory cache/ and include the Cache class:
Now we've setup the Cache instance and can start caching!
…You can also make use of the Method Chaining feature, introduced in PHP5.
So you can do something like that:
setCache('mycache') // generate new file
->store('hello', 'world') // store data string
->retrieve('hello'); // retrieve cached data
?>new Cache(/)
string gives you the basic setup.
It's the name of your Cache (standard Cache name is 'default'):
new Cache('YOUR-CACHE-NAME');array allows you to define multiple optional parameters:
new Cache(array(
'name' => 'YOUR-CACHE-NAME',
'path' => 'cache/',
'extension' => '.cache'
));If you don't define a Cache name with the constructor or the setCache() method, it'll be 'default'.
store($key, $data, )
key value defines a tag with which the cached data will be associated.data value can be any type of object (will be serialized).expiration value allows you to define an expiration time.To change data you can overwrite it by using the same key identifier.
Beside the data, the Cache will also store a timestamp.
A sample Cache entry looks like this:
{
"christmas": {
"time": 1324664631,
"expire": 28000,
"data": "s:29:"A great time to bake cookies.";" // serialized
}
}retrieve($key, )
Get particular cached data by its key.
To retrieve the timestamp of a key, set the second parameter to true.
retrieveAll()
This allows you retrieve all the cached data at once. You get the meta data by setting the $meta argument to true.
For erasing cached data are these three methods available:
erase($key) Erases a single entry by its key.eraseAll() Erases all entries from the Cache file.eraseExpired() Erases all expired entries.eraseExpired() . ' expired items erased!';
?>isCached($key)
Check whether any data is associated with the given key.
Returns true or false.
setCache($name)
If you want to switch to another Cache or create a new one, then use this method to set a new Cache name.
setCachePath($path)
The path to the Cache folder must end with a backslash: my_path_to_the_cache_folder/
getCacheDir()
The method returns the path to your current Cache file (the Cache name is always sh1 encoded):
cache/7505d64a54e061b7acd54ccd58b49dc43500b635.cacheIf you've done one, please let me know.
Upcoming: Simple Cache 2.0
Implementation of an internal "soft cache", hash-sum handling and the switch to serialization. Thanks @dariushha for his contribution!
Simple Cache 1.6 - 04/01/2014
update Updated docs.bug Fixed retrieveAll() method to unserialize data.Simple Cache 1.5 - 01/01/2014
feature added serialize / unserialize to store any kind of data.Simple Cache 1.4 - 08/09/2013
bug Fixed loading file twice in store() method.bug Fixed retrieve() method - made it fail safe (thanks @dariushha).Simple Cache 1.3 - 28/02/2013
update Updated docs for the added retrieveAll() method.feature Added retrieveAll() method (thanks @rpnzl).Simple Cache 1.2 - 09/05/2012
update Formatted codebug Fixed isCached() method so that it works as expected (thanks @TigerWolf).Simple Cache 1.1 - 01/01/2012
change The extension config has to start now with a dot.feature Added expiration handling to the store() methodfeature Added the methods eraseExpired() and eraseAll()feature Added method to make sure that a writable directory existsSimple Cache 1.0 - 29/12/2011
release First public versionfeature Added timestamp option to the retrieve() methodSimple Cache 0.9 - 25/12/2011
update Added Quick Start guide to the documentationfeature Added Method Chaining possibilitybug Fixed constructor configuration string/array handlingSimple Cache 0.8 - 24/12/2011
release First internal beta version (tested)feature Added Setter and Getter methodsupdate Detailed documentationSimple Cache 0.5 - 22/12/2011
release First internal alpha versionupdate Small documentationCopyright (c) 2011-2013 - Programmed by Christian Metz / @cosenary
Released under the BSD License.
暂无开放 Issues,或尚未同步最近议题。