SessionEvent
扩展 Event表示 Session 事件的类
| 自版本 |
2.0.0 |
|---|---|
| 包 |
Joomla 框架 |
方法
__construct
构造函数。
__construct( name, \Joomla\Session\SessionInterface session) :
__serialize
序列化事件。
__serialize() : mixed||string|int
| 自版本 |
2.0.0 |
|---|
返回值
array<string|int, mixed>要序列化的数据
__unserialize
反序列化事件。
__unserialize(mixed||string|int data) :
| 自版本 |
2.0.0 |
|---|
参数
- data
array<string|int, mixed>已序列化的事件。
返回值
void
addArgument
添加事件参数，仅当它不存在时。
addArgument( name, value) :
| 自版本 |
1.0 |
|---|
参数
- name
string参数名称。- value
mixed参数值。
返回值
$this
clearArguments
清除所有事件参数。
clearArguments() : mixed||string|int
| 自版本 |
1.0 |
|---|
返回值
array<string|int, mixed>旧的参数。
count
计算参数的数量。
count() :
| 自版本 |
1.0 |
|---|
返回值
int参数的数量。
getArgument
获取事件参数值。
getArgument( name, default = null) :
| 自版本 |
1.0 |
|---|
参数
- name
string参数名称。- default
mixed如果未找到，则为默认值。
返回值
mixed参数值或默认值。
getArguments
获取所有事件参数。
getArguments() : mixed||string|int
| 自版本 |
1.0 |
|---|
返回值
array<string|int, mixed>一个关联数组，其中参数名称作为键，其值作为值。
getName
获取事件名称。
getName() :
| 自版本 |
1.0 |
|---|
返回值
string事件名称。
getSession
检索附加到此事件的 SessionInterface 对象。
getSession() : \Joomla\Session\SessionInterface
hasArgument
判断给定的事件参数是否存在。
hasArgument( name) :
| 自版本 |
1.0 |
|---|
参数
- name
string参数名称。
返回值
bool如果存在，则为 true，否则为 false。
isStopped
判断事件传播是否已停止。
isStopped() :
| 自版本 |
1.0 |
|---|
返回值
bool如果已停止，则为 true，否则为 false。
offsetExists
判断给定的事件参数是否存在。
offsetExists( name) :
| 自版本 |
1.0 |
|---|
参数
- name
string参数名称。
返回值
bool如果存在，则为 true，否则为 false。
offsetGet
获取事件参数值。
offsetGet( name) :
| 自版本 |
1.0 |
|---|
参数
- name
string参数名称。
返回值
mixed参数值，如果不存在则为 null。
offsetSet
设置事件参数的值。
offsetSet( name, value) :
| 自版本 |
1.0 |
|---|---|
| 抛出 |
|
参数
- name
string参数名称。- value
mixed参数值。
返回值
void
offsetUnset
移除事件参数。
offsetUnset( name) :
| 自版本 |
1.0 |
|---|
参数
- name
string参数名称。
返回值
void
removeArgument
移除事件参数。
removeArgument( name) :
| 自版本 |
1.0 |
|---|
参数
- name
string参数名称。
返回值
mixed旧的参数值，如果不存在则为 null。
serialize
序列化事件。
serialize() :
| 自版本 |
1.0 |
|---|
返回值
string已序列化的事件。
setArgument
向事件添加参数。
setArgument( name, value) :
| 自版本 |
1.0 |
|---|
参数
- name
string参数名称。- value
mixed值。
返回值
$this
stop
停止事件传播。
stop() :
| 自版本 |
1.0 |
|---|---|
| 已弃用 |
3.0 使用 stopPropagation 代替 |
返回值
void
stopPropagation
停止将事件传播到后续的事件侦听器。
stopPropagation() :
| 自版本 |
2.0.0 |
|---|
返回值
void
unserialize
反序列化事件。
unserialize( serialized) :
| 自版本 |
1.0 |
|---|
参数
- 序列化
string已序列化的事件。
返回值
void
属性
name
事件名称。
| 自版本 |
1.0 |
|---|
类型
string
arguments
事件参数。
| 自版本 |
1.0 |
|---|
类型
array<string|int, mixed>
stopped
一个标志，用于查看事件传播是否已停止。
| 自版本 |
1.0 |
|---|
类型
bool