Joomla! API

下载
启动

RuntimeStorage

实现 StorageInterface

会话存储对象，将对象存储在运行时内存中。这旨在用于 CLI 应用程序，包括 PHPUnit 中的单元测试应用程序。

自

2.0.0
包

Joomla 框架

方法

abort

中止当前会话

abort() :
参见 session_abort()
自

2.0.0

返回值

bool

all

从会话存储中检索所有变量

all() : mixed||string|int

返回值

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

generateId

生成会话 ID

generateId() :
自

2.0.0

返回值

string

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成功时为真

remove

从会话存储中取消设置变量

remove( name) :
自

2.0.0

参数

name

string变量名称

返回值

mixed会话中的值，如果未设置则为 NULL

set

将数据设置到会话存储中

set( name,  value = null) :
自

2.0.0

参数

name

string变量名称

value

mixed变量的值

返回值

mixed变量的旧值

setId

设置会话 ID

setId( id) :
自

2.0.0
抛出

LogicException

参数

id

string会话 ID

返回值

$this

setName

设置会话名称

setName( name) :
自

2.0.0
抛出

LogicException

参数

name

string会话名称

返回值

$this

start

启动会话

start() :
自

2.0.0

返回值

void

属性

active

会话是否处于活动状态的标志

自

2.0.0

类型(s)

bool

closed

内部标志，指示会话是否已关闭

自

2.0.0

类型(s)

bool

data

内部数据存储

自

2.0.0

类型(s)

array<string|int, mixed>

id

会话 ID

自

2.0.0

类型(s)

string

name

会话名称

自

2.0.0

类型(s)

string

started

内部标志，指示会话是否已启动

自

2.0.0

类型(s)

bool
  • \ Joomla
  • \ Session
  • \ Storage
  • \ RuntimeStorage