README

FyreCache 是一个免费的、开源的 PHP 缓存库。

安装

使用 Composer

composer require fyre/cache

在 PHP 中

use Fyre\Cache\Cache;

方法

清除

清除所有实例和配置。

Cache::clear();

禁用

禁用缓存。

Cache::disable();

如果缓存被禁用，则 use 方法将始终返回一个 NullCacher。

启用

启用缓存。

Cache::enable();

获取配置

获取一个 缓存器 配置。

$key 是一个表示 缓存器 键的字符串。

$config = Cache::getConfig($key);

或者，如果省略了 $key 参数，将返回包含所有配置的数组。

$config = Cache::getConfig();

获取键

获取一个 缓存器 实例的键。

$cacher 是一个 缓存器。

$key = Cache::getKey($cacher);

检查配置

检查是否存在一个 缓存器 配置。

$key 是一个表示 缓存器 键的字符串，默认为 Cache::DEFAULT。

$hasConfig = Cache::hasConfig($key);

检查是否启用

检查缓存是否启用。

Cache::isEnabled();

检查是否已加载

检查一个 缓存器 实例是否已加载。

$key 是一个表示 缓存器 键的字符串，默认为 Cache::DEFAULT。

$isLoaded = Cache::isLoaded($key);

加载

加载一个 缓存器。

$options 是一个包含配置选项的数组。

$cacher = Cache::load($options);

设置配置

设置 缓存器 配置。

$key 是一个表示 缓存器 键的字符串。
$options 是一个包含配置选项的数组。

Cache::setConfig($key, $options);

或者，可以提供一个包含配置选项键/值对的单个数组。

Cache::setConfig($config);

卸载

卸载一个 缓存器。

$key 是一个表示 缓存器 键的字符串，默认为 Cache::DEFAULT。

$unloaded = Cache::unload($key);

使用

加载一个共享的 缓存器 实例。

$key 是一个表示 缓存器 键的字符串，默认为 Cache::DEFAULT。

$cacher = Cache::use($key);

缓存器

您可以通过指定上面 $options 变量的 className 选项来加载一个特定的缓存器。

可以通过扩展 \Fyre\Cache\Cacher 创建自定义缓存器，确保实现所有以下方法。

递减

递减缓存值。

$key 是一个表示缓存键的字符串。
$amount 是一个表示要递减的数量的数字，默认为 1。

$value = $cacher->decrement($key, $amount);

删除

从缓存中删除一个项目。

$key 是一个表示缓存键的字符串。

$deleted = $cacher->delete($key);

清空

清空缓存。

$emptied = $cacher->empty();

获取

从缓存中检索一个值。

$key 是一个表示缓存键的字符串。

$value = $cacher->get($key);

检查存在

确定一个项目是否存在于缓存中。

$key 是一个表示缓存键的字符串。

$has = $cacher->has($key);

递增

递增缓存值。

$key 是一个表示缓存键的字符串。
$amount 是一个表示要递增的数量的数字，默认为 1。

$value = $cacher->increment($key, $amount);

记住

从缓存中检索一个项目，如果不存在则保存新值。

$key 是一个表示缓存键的字符串。
$callback 是生成值的回调方法。
$expire 是一个表示值有效性的秒数的数字，默认为 null。

$value = $cacher->remember($key, $callback, $expire);

保存

将一个项目保存到缓存中。

$key 是一个表示缓存键的字符串。
$value 是要保存到缓存中的值。
$expire 是一个表示值有效性的秒数的数字，默认为 null。

$saved = $cacher->save($key, $value, $expire);

大小

获取缓存的大小。

$size = $cacher->size();

文件

可以使用自定义配置加载文件缓存器。

$key 是一个表示缓存器键的字符串。
$options 是一个包含配置选项的数组。
- className 必须设置为 \Fyre\Cache\Handlers\FileCacher。
- expire 是一个表示默认缓存超时的数字。
- prefix 是一个表示缓存键前缀的字符串。
- path 是一个表示目录路径的字符串，默认为 "/tmp/cache"。
- mode 是一个表示缓存文件权限的数字，默认为 0640。

Cache::setConfig($key, $options);

$cacher = Cache::use($key);

Memcached

可以使用自定义配置加载 Memcached 缓存器。

$key 是一个表示缓存器键的字符串。
$options 是一个包含配置选项的数组。
- className 必须设置为 \Fyre\Cache\Handlers\MemcachedCacher。
- expire 是一个表示默认缓存超时的数字。
- prefix 是一个表示缓存键前缀的字符串。
- host 是表示 Memcached 主机的字符串，默认为 "127.0.0.1"。
- port 是表示 Memcached 端口的数字，默认为 11211。
- weight 是表示服务器权重的数字，默认为 1。

Cache::setConfig($key, $options);

$cacher = Cache::use($key);

Redis

可以使用自定义配置加载 Redis 缓存器。

$key 是一个表示缓存器键的字符串。
$options 是一个包含配置选项的数组。
- className 必须设置为 \Fyre\Cache\Handlers\RedisCacher。
- expire 是一个表示默认缓存超时的数字。
- prefix 是一个表示缓存键前缀的字符串。
- host 是表示 Redis 主机的字符串，默认为 "127.0.0.1"。
- password 是表示 Redis 密码的字符串。
- port 是表示 Redis 端口的数字，默认为 6379。
- database 是表示 Redis 数据库的字符串。
- timeout 是表示连接超时的数字。

Cache::setConfig($key, $options);

$cacher = Cache::use($key);

fyre / cache

维护者

详细信息

README

目录

安装

方法

缓存器

文件

Memcached

Redis