session类
| 版本 | 1.0+ |
| 命名空间 | boa |
| 文件 | boa/session.php |
| 说明 | session类(会话服务器端),配置:'SESSION' => [], |
配置
| 配置项 | 默认值 | 类型 | 说明 |
|---|---|---|---|
| driver | file | string | 会话驱动,可选值:file, memcache, memcached, redis |
目录
| 方法 | 说明 |
|---|---|
| __construct() | 初始化 |
| ttl() | 设置会话ID(PHPSESSID)的cookie有效期 |
| sid() | 获取Session ID |
| get() | 读取session |
| set() | 设置session |
| del() | 删除session |
| gc() | session回收 |
| save() | 保存并关闭会话 |
| clear() | 销毁会话 |
方法
| 说明 | ||||
|---|---|---|---|---|
| 初始化 | ||||
| 参数 | 必须 | 默认值 | 类型 | 说明 |
| $cfg | [] | array | 配置数据 | |
| 示例 | ||||
|
||||
| 说明 | ||||
|---|---|---|---|---|
| 设置会话ID(PHPSESSID)的cookie有效期 | ||||
| 参数 | 必须 | 默认值 | 类型 | 说明 |
| $second | Y | int | cookie有效时长(秒) | |
| 示例 | ||||
|
||||
| 说明 | ||||
|---|---|---|---|---|
| 获取Session ID | ||||
| 返回值 | ||||
| 返回会话ID(string) | ||||
| 示例 | ||||
|
| 说明 | ||||
|---|---|---|---|---|
| 读取session | ||||
| 参数 | 必须 | 默认值 | 类型 | 说明 |
| $key | Y | string | 键,支持多维数组,如:user.group.name | |
| 返回值 | ||||
| 返回session值(mixed) | ||||
| 示例 | ||||
|
||||
| 说明 | ||||
|---|---|---|---|---|
| 设置session | ||||
| 参数 | 必须 | 默认值 | 类型 | 说明 |
| $key | Y | string | 键,支持多维数组,如:user.group.name | |
| $val | Y | string | 值 | |
| 示例 | ||||
|
||||
| 说明 | ||||
|---|---|---|---|---|
| 删除session | ||||
| 参数 | 必须 | 默认值 | 类型 | 说明 |
| $key | Y | string | 键,支持多维数组,如:user.group.name | |
| 示例 | ||||
|
||||
| 说明 | ||||
|---|---|---|---|---|
| session回收 | ||||
| 返回值 | ||||
| 成功返回删除session数量(int),失败返回false(bool) |
| 说明 | ||||
|---|---|---|---|---|
| 保存并关闭会话 | ||||
| 返回值 | ||||
| 成功返回true(bool),失败返回false(bool) |
| 说明 | ||||
|---|---|---|---|---|
| 销毁会话 | ||||
| 返回值 | ||||
| 成功返回true(bool),失败返回false(bool) |