runtime.func.php API参考文档
# runtime.func.php API 参考文档
## 概述
`runtime.func.php` 是 Xiuno BBS 的运行时数据管理模块,提供了运行时数据的初始化、获取、设置、删除和保存等核心功能。
## 核心方法
### `runtime_init()`
#### 说明
```php
function runtime_init(): array
```
初始化运行时数据,包括用户数、帖子数、主题数、在线人数等统计信息。
#### 参数
- 无参数
#### 返回值
- 返回运行时数据数组
#### 示例
```php
$runtime = runtime_init();
```
### `runtime_get()`
#### 说明
```php
function runtime_get(string $k): mixed
```
获取运行时数据中的指定键值。
#### 参数
- `$k`: 要获取的键名
#### 返回值
- 返回对应的值,如果不存在返回 NULL
#### 示例
```php
$users = runtime_get('users');
```
### `runtime_set()`
#### 说明
```php
function runtime_set(string $k, mixed $v): bool
```
设置运行时数据中的指定键值,支持增量操作。
#### 参数
- `$k`: 要设置的键名,末尾可以加 '+' 或 '-' 表示增量操作
- `$v`: 要设置的值
#### 返回值
- 成功返回 TRUE
#### 示例
```php
// 设置固定值
runtime_set('users', 1000);
// 增量操作
runtime_set('users+', 1); // 增加 1
runtime_set('users-', 1); // 减少 1
```
### `runtime_delete()`
#### 说明
```php
function runtime_delete(string $k): bool
```
删除运行时数据中的指定键值。
#### 参数
- `$k`: 要删除的键名
#### 返回值
- 成功返回 TRUE
#### 示例
```php
runtime_delete('users');
```
### `runtime_save()`
#### 说明
```php
function runtime_save(): void
```
保存运行时数据到缓存。
#### 参数
- 无参数
#### 返回值
- 无返回值
#### 示例
```php
runtime_save();
```
### `runtime_truncate()`
#### 说明
```php
function runtime_truncate(): void
```
清空运行时数据缓存。
#### 参数
- 无参数
#### 返回值
- 无返回值
#### 示例
```php
runtime_truncate();
```