Download the PHP package fyre/cache without Composer
On this page you can find all versions of the php package fyre/cache. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package cache
FyreCache
FyreCache is a free, open-source cache library for PHP.
Table Of Contents
- Installation
- Methods
- Cachers
- File
- Memcached
- Redis
Installation
Using Composer
In PHP:
Methods
Clear
Clear all instances and configs.
Disable
Disable the cache.
If the cache is disabled, the use
method will always return a NullCacher.
Enable
Enable the cache.
Get Config
Get a Cacher config.
$key
is a string representing the Cacher key.
Alternatively, if the $key
argument is omitted an array containing all configurations will be returned.
Get Key
Get the key for a Cacher instance.
$cacher
is a Cacher.
Has Config
Check if a Cacher config exists.
$key
is a string representing the Cacher key, and will default toCache::DEFAULT
.
Is Enabled
Check if the cache is enabled.
Is Loaded
Check if a Cacher instance is loaded.
$key
is a string representing the Cacher key, and will default toCache::DEFAULT
.
Load
Load a Cacher.
$options
is an array containing configuration options.
Set Config
Set the Cacher config.
$key
is a string representing the Cacher key.$options
is an array containing configuration options.
Alternatively, a single array can be provided containing key/value of configuration options.
Unload
Unload a Cacher.
$key
is a string representing the Cacher key, and will default toCache::DEFAULT
.
Use
Load a shared Cacher instance.
$key
is a string representing the Cacher key, and will default toCache::DEFAULT
.
Cachers
You can load a specific cacher by specifying the className
option of the $options
variable above.
Custom cachers can be created by extending \Fyre\Cache\Cacher
, ensuring all below methods are implemented.
Decrement
Decrement a cache value.
$key
is a string representing the cache key.$amount
is a number indicating the amount to decrement by, and will default to 1.
Delete
Delete an item from the cache.
$key
is a string representing the cache key.
Empty
Empty the cache.
Get
Retrieve a value from the cache.
$key
is a string representing the cache key.
Has
Determine if an item exists in the cache.
$key
is a string representing the cache key.
Increment
Increment a cache value.
$key
is a string representing the cache key.$amount
is a number indicating the amount to increment by, and will default to 1.
Remember
Retrieve an item from the cache, or save a new value if it doesn't exist.
$key
is a string representing the cache key.$callback
is the callback method to generate the value.$expire
is a number indicating the number of seconds the value will be valid, and will default to null.
Save
Save an item in the cache.
$key
is a string representing the cache key.$value
is the value to save in the cache.$expire
is a number indicating the number of seconds the value will be valid, and will default to null.
Size
Get the size of the cache.
File
The File cacher can be loaded using custom configuration.
$key
is a string representing the cacher key.$options
is an array containing configuration options.className
must be set to\Fyre\Cache\Handlers\FileCacher
.expire
is a number indicating the default cache timeout.prefix
is a string representing the cache key prefix.path
is a string representing the directory path, and will default to "/tmp/cache".mode
is a number indicating the cache file permissions, and will default to 0640.
Memcached
The Memcached cacher can be loaded using custom configuration.
$key
is a string representing the cacher key.$options
is an array containing configuration options.className
must be set to\Fyre\Cache\Handlers\MemcachedCacher
.expire
is a number indicating the default cache timeout.prefix
is a string representing the cache key prefix.host
is a string representing the Memcached host, and will default to "127.0.0.1".port
is a number indicating the Memcached port, and will default to 11211.weight
is a number indicating the server weight, and will default to 1.
Redis
The Redis cacher can be loaded using custom configuration.
$key
is a string representing the cacher key.$options
is an array containing configuration options.className
must be set to\Fyre\Cache\Handlers\RedisCacher
.expire
is a number indicating the default cache timeout.prefix
is a string representing the cache key prefix.host
is a string representing the Redis host, and will default to "127.0.0.1".password
is a string representing the Redis password.port
is a number indicating the Redis port, and will default to 6379.database
is a string representing the Redis database.timeout
is a number indicating the connection timeout.
All versions of cache with dependencies
fyre/container Version ^1.0
fyre/filesystem Version ^2.0
fyre/path Version ^2.0