kv.func.php API参考文档

2026-08-13 08:58

# kv.func.php API 参考文档 ## 概述 `kv.func.php` 是 Xiuno BBS 的键值对存储模块，提供了键值对的存储、读取、删除等核心功能，支持缓存和设置管理。 ## 无缓存键值对操作 ### `kv__get()` #### 说明 ```php function kv__get(string $k): mixed ``` 从数据库中读取键值对，无缓存。 #### 参数 - `$k`: 键名 #### 返回值 - 成功返回对应的值 - 失败返回 NULL #### 示例 ```php $value = kv__get('test_key'); ``` ### `kv_get()` #### 说明 ```php function kv_get(string $k): mixed ``` 读取键值对，带静态缓存。 #### 参数 - `$k`: 键名 #### 返回值 - 成功返回对应的值 - 失败返回 NULL #### 示例 ```php $value = kv_get('test_key'); ``` ### `kv_set()` #### 说明 ```php function kv_set(string $k, mixed $v, int $life = 0): bool ``` 设置键值对。 #### 参数 - `$k`: 键名 - `$v`: 值 - `$life`: 生命周期，默认为 0（永久） #### 返回值 - 成功返回 TRUE - 失败返回 FALSE #### 示例 ```php $r = kv_set('test_key', 'test_value'); ``` ### `kv_delete()` #### 说明 ```php function kv_delete(string $k): bool ``` 删除键值对。 #### 参数 - `$k`: 键名 #### 返回值 - 成功返回 TRUE - 失败返回 FALSE #### 示例 ```php $r = kv_delete('test_key'); ``` ## 带缓存的键值对操作 ### `kv_cache_get()` #### 说明 ```php function kv_cache_get(string $k): mixed ``` 从缓存中读取键值对，如果缓存不存在则从数据库读取。 #### 参数 - `$k`: 键名 #### 返回值 - 成功返回对应的值 - 失败返回 NULL #### 示例 ```php $value = kv_cache_get('test_key'); ``` ### `kv_cache_set()` #### 说明 ```php function kv_cache_set(string $k, mixed $v, int $life = 0): bool ``` 设置键值对，同时更新缓存。 #### 参数 - `$k`: 键名 - `$v`: 值 - `$life`: 生命周期，默认为 0（永久） #### 返回值 - 成功返回 TRUE - 失败返回 FALSE #### 示例 ```php $r = kv_cache_set('test_key', 'test_value'); ``` ### `kv_cache_delete()` #### 说明 ```php function kv_cache_delete(string $k): bool ``` 删除键值对，同时删除缓存。 #### 参数 - `$k`: 键名 #### 返回值 - 成功返回 TRUE - 失败返回 FALSE #### 示例 ```php $r = kv_cache_delete('test_key'); ``` ## 设置管理 ### `setting_get()` #### 说明 ```php function setting_get(string $k): mixed ``` 获取系统设置值。 #### 参数 - `$k`: 设置键名 #### 返回值 - 成功返回对应的值 - 失败返回 NULL #### 示例 ```php $value = setting_get('site_name'); ``` ### `setting_set()` #### 说明 ```php function setting_set(string $k, mixed $v): bool ``` 设置系统设置值。 #### 参数 - `$k`: 设置键名 - `$v`: 设置值 #### 返回值 - 成功返回 TRUE - 失败返回 FALSE #### 示例 ```php $r = setting_set('site_name', 'Xiuno BBS'); ``` ### `setting_delete()` #### 说明 ```php function setting_delete(string $k): bool ``` 删除系统设置值。 #### 参数 - `$k`: 设置键名 #### 返回值 - 成功返回 TRUE - 失败返回 FALSE #### 示例 ```php $r = setting_delete('site_name'); ```

kv.func.php API参考文档

菜单

设置

归档