boaPHP开发手册v5.5

cache类
版本 1.0+
命名空间 boa
文件 boa/cache.php
说明 缓存类，配置：'CACHE' => [],
配置
配置项 默认值 类型 说明
driver file string 缓存驱动，可选值：apcu, file, memcache, memcached, redis, wincache, xcache
目录
方法 说明
__construct() 初始化
key() 返回当前xget()方法缓存键名
get() 读取缓存
set() 设置缓存
xget() 读取缓存器
del() 删除缓存
clear() 清除所有缓存
cname() 依据参数计算xget()方法键名
方法

__construct()

↑
说明
初始化
参数 必须 默认值 类型 说明
$cfg [] array 配置数据
示例 
$cache = boa::cache();

key()

↑
说明
返回当前xget()方法缓存键名
返回值
返回键（string）
示例 
$arr = $cache->xget(...);
$key = $cache->key();

get()

↑
说明
读取缓存
参数 必须 默认值 类型 说明
$name Y string 缓存键名
返回值
返回缓存结果（mixed）；失败返回false（bool）
示例 
$val = $cache->get('key');

set()

↑
说明
设置缓存
参数 必须 默认值 类型 说明
$name Y string 缓存键名
$val Y mixed 缓存值，支持标量、数组、对象等类型
$ttl 0 int 缓存有效期（秒），0=默认
返回值
成功返回true（bool）；失败返回false（bool）
示例 
$res = $cache->set('key', $val, 3600); // 缓存有效期1个小时

xget()

↑
说明
读取缓存器
参数 必须 默认值 类型 说明
$name Y string 缓存器名
$args [] array 缓存器参数
$ttl 0 int 缓存有效期（秒），0=跟随expire配置
返回值
返回缓存结果（mixed）；失败返回false（bool）
示例 
$arr = $cache->xget('home.test', ['pid' => 1], 7200); // 创建缓存时，设置缓存有效期2个小时

del()

↑
说明
删除缓存
参数 必须 默认值 类型 说明
$name Y string 缓存键名
返回值
成功返回true（bool）；失败返回false（bool）
示例 
$cache->del('key');

clear()

↑
说明
清除所有缓存
示例 
$cache->clear();

cname()

↑
说明
依据参数计算xget()方法键名
参数 必须 默认值 类型 说明
$name Y string 缓存器名
$args [] array 缓存器参数
返回值
返回键（string）
示例 
$cname = $cache->cname('permission', ['group' => $gid]);
$cache->del($cname);