gilbitron / hoard
PHP caching done right
Requires
- php: >=5.4.0
Requires (Dev)
- phpunit/phpunit: 4.4.*
This package is auto-updated.
Last update: 2024-10-12 03:31:25 UTC
README
Hoard is a simple, extensible PHP caching library.
Install
Install via composer:
{ "require": { "gilbitron/hoard": "~0.1.0" } }
Run composer install
then use as normal:
require 'vendor/autoload.php'; $cache = new Hoard\Hoard();
API
Hoard uses the conecpt of "drawers" (as in a chest of drawers) as drivers for caching.
$cache = new Hoard\Hoard($drawer = 'file', $options = [], $args = []);
Possible drawers (more to come):
file
$options
is an array of options passed to the chosen drawer. See Drawers section below.
$args
:
encrypt_keys
- Use encrypted keys (default:true
)encryption_function
- Function to use for encrypting keysmd5
/sha1
(default:md5
)
Determine if an item exists in the cache
$cache->has($key);
Retrieve an item from the cache by key
$cache->get($key, $default = null);
Retrieve an item from the cache and delete it
$cache->pull($key, $default = null);
Store an item in the cache. $minutes
can be an int or DateTime
$cache->put($key, $value, $minutes);
Store an item in the cache if the key does not exist. $minutes
can be an int or DateTime
$cache->add($key, $value, $minutes);
Store an item in the cache indefinitely
$cache->forever($key, $value);
Remove an item from the cache
$cache->forget($key);
Remove all items from the cache
$cache->flush();
Drawers
file
Basic FileSystem caching.
Options:
cache_dir
- Path to cache directory. Uses the system tmp dir if none provided.
Credits
Hoard was created by Gilbert Pellegrom from Dev7studios. Released under the MIT license.