boa框架开发手册v5.2

session类
版本 1.0+
命名空间 boa
文件 boa/session.php
说明 session类(服务器端),继承base类,配置:'SESSION' => [],
配置
配置项 默认值 类型 说明
driver file string 会话驱动,可选值:file, memcache, memcached, redis
expire 0 int 会话cookie超时(秒)
目录
方法 说明
__construct() 初始化
cfg() 获取或设置配置信息
__get() 魔术方法,以属性的方式获取配置,等同于cfg($k)
__set() 魔术方法,以属性的方式设置配置,等同于cfg($k, $v)
sid() 获取Session ID
get() 读取session
set() 设置session
del() 删除session
gc() session回收
save() 保存并关闭会话
clear() 销毁会话
方法

__construct()

说明
初始化
参数 必须 默认值 类型 说明
$cfg [] array 配置数据

cfg()

说明
获取或设置配置信息
参数 必须 默认值 类型 说明
$k null string
$v null string
返回值
如果设定$k和$v:则设置配置中$k项,返回$this(object);
如果只设定$k:则返回配置中$k值(string);
如果都未设定:则返回整个配置数据(array);

__get()

说明
魔术方法,以属性的方式获取配置,等同于cfg($k)
参数 必须 默认值 类型 说明
$k Y string
返回值
返回配置值(string)

__set()

说明
魔术方法,以属性的方式设置配置,等同于cfg($k, $v)
参数 必须 默认值 类型 说明
$k Y string
$v Y string

sid()

说明
获取Session ID
返回值
返回会话ID(string)

get()

说明
读取session
参数 必须 默认值 类型 说明
$key Y string 键,支持多维数组,如:user.group.name
返回值
返回session值(mixed)
示例
$sess = boa::session();
$sess->get('user');
$sess->get('user.group');

set()

说明
设置session
参数 必须 默认值 类型 说明
$key Y string 键,支持多维数组,如:user.group.name
$val Y string
示例
$sess = boa::session();
$sess->set('name', 'BOA');
$sess->set('user.group.name', 'admin');

del()

说明
删除session
参数 必须 默认值 类型 说明
$key Y string 键,支持多维数组,如:user.group.name
示例
$sess = boa::session();
$sess->del('user');
$sess->del('user.group');

gc()

说明
session回收
返回值
成功返回删除session数量(int),失败返回false(bool)

save()

说明
保存并关闭会话
返回值
成功返回true(bool),失败返回false(bool)

clear()

说明
销毁会话
返回值
成功返回true(bool),失败返回false(bool)