NativeStorage
实现 StorageInterface提供会话存储的基本类
| 自 |
2.0.0 |
|---|---|
| 包 |
Joomla 框架 |
方法
__construct
构造函数
__construct(\SessionHandlerInterface handler = null, mixed||string|int options = []) :
| 自 |
1.0 |
|---|
参数
- handler
SessionHandlerInterface|null会话保存处理程序- options
array<string|int, mixed>会话选项
响应
混合
abort
中止当前会话
abort() :
| 参见 | session_abort() |
|---|---|
| 自 |
2.0.0 |
响应
布尔值
all
从会话存储中检索所有变量
all() : mixed||string|int
| 自 |
2.0.0 |
|---|
响应
array<string|int, mixed>
clear
清除会话存储中的所有变量
clear() :
| 自 |
2.0.0 |
|---|
响应
空
close
写入会话数据并结束会话
close() :
| 参见 | session_write_close() |
|---|---|
| 自 |
2.0.0 |
响应
空
gc
执行会话数据垃圾回收
gc() : int|bool
| 参见 | session_gc() |
|---|---|
| 自 |
2.0.0 |
响应
int|bool成功时删除的会话数，失败时为布尔值 false，或者如果函数不受支持则为 false
get
从会话存储中获取数据
get( name, default) :
| 自 |
2.0.0 |
|---|
参数
- name
string变量的名称- default
mixed如果未设置，则为变量的默认值
响应
mixed变量的值
getHandler
获取保存处理程序实例
getHandler() : \SessionHandlerInterface|null
| 自 |
2.0.0 |
|---|
响应
SessionHandlerInterface|null
getId
获取会话 ID
getId() :
| 自 |
2.0.0 |
|---|
响应
string会话 ID
getName
获取会话名称
getName() :
| 自 |
2.0.0 |
|---|
响应
string会话名称
has
检查会话存储中是否存在数据
has( name) :
| 自 |
2.0.0 |
|---|
参数
- name
string变量的名称
响应
布尔值
isActive
检查会话是否处于活动状态
isActive() :
| 自 |
2.0.0 |
|---|
响应
布尔值
isStarted
检查会话是否已启动
isStarted() :
| 自 |
2.0.0 |
|---|
响应
布尔值
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 = null) :
| 自 |
2.0.0 |
|---|
参数
- name
string变量的名称- value
mixed变量的值
响应
mixed变量的旧值
setHandler
将会话保存处理程序注册为 PHP 会话处理程序
setHandler(\SessionHandlerInterface handler = null) :
| 自 |
2.0.0 |
|---|---|
| 抛出 |
|
参数
- handler
SessionHandlerInterface|null要使用的保存处理程序
响应
$this
setId
设置会话 ID
setId( id) :
| 自 |
2.0.0 |
|---|---|
| 抛出 |
|
参数
- id
string会话 ID
响应
$this
setName
设置会话名称
setName( name) :
| 自 |
2.0.0 |
|---|---|
| 抛出 |
|
参数
- name
string会话名称
响应
$this
setOptions
设置 session.* ini 变量。
setOptions(mixed||string|int options) :
为了方便起见，我们省略了键开头的“session.”。显式忽略其他 ini 键。
| 注意 |
基于 \Symfony\Component\HttpFoundation\Session\Storage\NativeSessionStorage::setOptions() |
|---|---|
| 参见 |
https://php.ac.cn/session.configuration |
| 自 |
2.0.0 |
参数
- options
array<string|int, mixed>会话 ini 指令数组（键 => 值）。
响应
$this
start
启动会话
start() :
| 自 |
2.0.0 |
|---|
响应
空
属性
active
会话是否处于活动状态的标志
| 自 |
2.0.0 |
|---|
类型
布尔值
closed
标识会话是否已关闭的内部标志
| 自 |
2.0.0 |
|---|
类型
布尔值
handler
会话保存处理程序
| 自 |
2.0.0 |
|---|
类型
SessionHandlerInterface
started
标识会话是否已启动的内部标志
| 自 |
2.0.0 |
|---|
类型
布尔值