cache.func.php API参考文档

2026-08-13 08:57

# cache.func.php API 参考文档 ## 概述 `cache.func.php` 是 Xiuno BBS 的缓存管理模块，提供了缓存的初始化、获取、设置、删除和清空等核心功能，支持多种缓存类型如 Redis、Memcached、MySQL、XCache、APC 和 YAC。 ## 核心方法 ### `cache_new()` #### 说明 ```php function cache_new(array $cacheconf): object|null ``` 初始化缓存，创建缓存实例。 #### 参数 - `$cacheconf`: 缓存配置数组，包含 type、enable 等字段 #### 返回值 - 成功返回缓存对象 - 失败返回 NULL #### 示例 ```php $cacheconf = array( 'enable' => 1, 'type' => 'redis', 'redis' => array( 'host' => '127.0.0.1', 'port' => 6379, 'timeout' => 0, 'pconnect' => 1, 'db' => 0, 'password' => '' ) ); $cache = cache_new($cacheconf); ``` ### `cache_get()` #### 说明 ```php function cache_get(string $k, object|null $c = NULL): mixed ``` 获取缓存值。 #### 参数 - `$k`: 缓存键名 - `$c`: 缓存对象，默认为 NULL（使用全局缓存对象） #### 返回值 - 成功返回缓存值 - 失败返回 FALSE #### 示例 ```php $value = cache_get('test_key'); ``` ### `cache_set()` #### 说明 ```php function cache_set(string $k, mixed $v, int $life = 0, object|null $c = NULL): bool ``` 设置缓存值。 #### 参数 - `$k`: 缓存键名 - `$v`: 缓存值 - `$life`: 生命周期，默认为 0（永久） - `$c`: 缓存对象，默认为 NULL（使用全局缓存对象） #### 返回值 - 成功返回 TRUE - 失败返回 FALSE #### 示例 ```php $r = cache_set('test_key', 'test_value', 3600); ``` ### `cache_delete()` #### 说明 ```php function cache_delete(string $k, object|null $c = NULL): bool ``` 删除缓存值。 #### 参数 - `$k`: 缓存键名 - `$c`: 缓存对象，默认为 NULL（使用全局缓存对象） #### 返回值 - 成功返回 TRUE - 失败返回 FALSE #### 示例 ```php $r = cache_delete('test_key'); ``` ### `cache_truncate()` #### 说明 ```php function cache_truncate(object|null $c = NULL): bool ``` 清空所有缓存。 #### 参数 - `$c`: 缓存对象，默认为 NULL（使用全局缓存对象） #### 返回值 - 成功返回 TRUE - 失败返回 FALSE #### 示例 ```php $r = cache_truncate(); ```

cache.func.php API参考文档

菜单

设置

归档