StorageInterface
定义 Joomla! 会话存储对象的接口
| 自 |
2.0.0 |
|---|---|
| 包 |
Joomla 框架 |
方法
abort
中止当前会话
abort() :
| 参见 | session_abort() |
|---|---|
| 自 |
2.0.0 |
响应
bool
all
从会话存储中检索所有变量
all() : mixed||string|int
| 自 |
2.0.0 |
|---|
响应
array<string|int, mixed>
clear
从会话存储中清除所有变量
clear() :
| 自 |
2.0.0 |
|---|
响应
void
close
写入会话数据并结束会话
close() :
| 参见 | session_write_close() |
|---|---|
| 自 |
2.0.0 |
响应
void
gc
执行会话数据垃圾回收
gc() : int|bool
| 参见 | session_gc() |
|---|---|
| 自 |
2.0.0 |
响应
int|bool成功时删除的会话数，或失败时或函数不受支持时的布尔值 false
get
从会话存储中获取数据
get( name, default) :
| 自 |
2.0.0 |
|---|
参数
- name
string变量的名称- default
mixed如果未设置，则为变量的默认值
响应
mixed变量的值
getId
获取会话 ID
getId() :
| 自 |
2.0.0 |
|---|
响应
string会话 ID
getName
获取会话名称
getName() :
| 自 |
2.0.0 |
|---|
响应
string会话名称
has
检查会话存储中是否存在数据
has( name) :
| 自 |
2.0.0 |
|---|
参数
- name
string变量的名称
响应
bool
isActive
检查会话是否处于活动状态
isActive() :
| 自 |
2.0.0 |
|---|
响应
bool
isStarted
检查会话是否已启动
isStarted() :
| 自 |
2.0.0 |
|---|
响应
bool
regenerate
重新生成代表此存储的会话 ID。
regenerate( destroy = false) :
此方法必须调用 session_regenerate_id($destroy)，除非此接口用于为旨在进行单元或功能测试的存储对象设计的，在这种情况下，真实的 PHP 会话会干扰测试。
| 参见 | session_regenerate_id() |
|---|---|
| 自 |
2.0.0 |
参数
- destroy
bool重新生成时销毁会话？
响应
bool成功时为 True
remove
从会话存储中取消设置变量
remove( name) :
| 自 |
2.0.0 |
|---|
参数
- name
string变量的名称
响应
mixed会话中的值，如果未设置则为 NULL
set
将数据设置到会话存储中
set( name, value) :
| 自 |
2.0.0 |
|---|
参数
- name
string变量的名称- value
mixed变量的值
响应
mixed变量的旧值
setId
设置会话 ID
setId( id) :
| 自 |
2.0.0 |
|---|
参数
- id
string会话 ID
响应
$this
setName
设置会话名称
setName( name) :
| 自 |
2.0.0 |
|---|
参数
- name
string会话名称
响应
$this
start
启动会话
start() :
| 自 |
2.0.0 |
|---|
响应
void