SessionInterface
扩展 IteratorAggregate定义 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() :
会话数据通常在您的脚本终止后存储，无需调用 SessionInterface::close()，但由于会话数据被锁定以防止并发写入，因此任何时候只有一个脚本可以操作会话。当将框架集与会话一起使用时，由于此锁定，您将体验到框架一个接一个地加载。您可以通过在对会话变量的所有更改完成后结束会话来减少加载所有框架所需的时间。
| 参见 | session_write_close() |
|---|---|
| 自 |
2.0.0 |
响应
void
destroy
释放所有会话变量并销毁注册到会话的所有数据
destroy() :
此方法重置 $_SESSION 变量并销毁与其存储（文件或数据库）中当前会话关联的所有数据。它强制在调用此方法后启动新会话。它不会取消设置会话 Cookie。
| 参见 | session_destroy() session_unset() |
|---|---|
| 自 |
2.0.0 |
响应
bool
fork
创建新会话并从旧会话复制变量
fork() :
| 自 |
2.0.0 |
|---|
响应
bool
gc
执行会话数据垃圾回收
gc() : int|bool
| 参见 | session_gc() |
|---|---|
| 自 |
2.0.0 |
响应
int|bool成功时删除的会话数，或失败时或如果函数不受支持则为布尔值 false
get
从会话存储中获取数据
get( name, default = null) :
| 自 |
2.0.0 |
|---|
参数
- name
string变量的名称- default
mixed如果未设置，则为变量的默认值
响应
mixed变量的值
getExpire
获取以秒为单位的过期时间
getExpire() :
| 自 |
2.0.0 |
|---|
响应
int会话过期时间（以秒为单位）
getId
获取会话 ID
getId() :
| 自 |
2.0.0 |
|---|
响应
string会话 ID
getName
获取会话名称
getName() :
| 自 |
2.0.0 |
|---|
响应
string会话名称
getToken
获取会话令牌。
getToken( forceNew = false) :
令牌用于保护表单免受垃圾邮件攻击。生成令牌后，系统将检查请求中是否存在令牌，如果不存在，则会使会话失效。
| 自 |
2.0.0 |
|---|
参数
- forceNew
bool如果为 true，则强制创建新令牌
响应
string
has
检查会话存储中是否存在数据
has( name) :
| 自 |
2.0.0 |
|---|
参数
- name
string变量的名称
响应
bool如果变量存在，则为 true
hasToken
检查会话是否具有给定的令牌。
hasToken( token, forceExpire = true) :
| 自 |
2.0.0 |
|---|
参数
- token
string要验证的哈希令牌- forceExpire
bool如果为 true，则会话过期
响应
bool
isActive
检查会话是否处于活动状态
isActive() :
| 自 |
2.0.0 |
|---|
响应
bool
isNew
检查此会话是否新创建
isNew() :
| 自 |
2.0.0 |
|---|
响应
bool
isStarted
检查会话是否已启动
isStarted() :
| 自 |
2.0.0 |
|---|
响应
bool
remove
从会话存储中取消设置变量
remove( name) :
| 自 |
2.0.0 |
|---|
参数
- name
string变量的名称
响应
mixed会话中的值，如果未设置则为 NULL
restart
重新启动已过期或锁定的会话
restart() :
| 参见 | destroy |
|---|---|
| 自 |
2.0.0 |
响应
bool成功时为 true
set
将数据设置到会话存储中
set( name, value = null) :
| 自 |
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