EventImmutable
扩展 AbstractEvent不可变事件的实现。
不可变事件在实例化后无法修改
- 它的传播无法停止
- 它的参数无法修改
当您想要确保监听器不会操作它时,您可能想要使用此事件。
自 |
1.0 |
---|---|
包 |
Joomla 框架 |
方法
__construct
构造函数。
__construct( name, mixed||string|int arguments = []) :
抛出 |
|
---|---|
自 |
1.0 |
参数
- name
string
事件名称。- arguments
array<string|int, mixed>
事件参数。
响应
mixed
__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
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
事件名称。
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
serialize
序列化事件。
serialize() :
自 |
1.0 |
---|
响应
string
序列化后的事件。
stopPropagation
停止事件传播到进一步的事件监听器。
stopPropagation() :
自 |
2.0.0 |
---|
响应
void
unserialize
反序列化事件。
unserialize( serialized) :
自 |
1.0 |
---|
参数
- serialized
string
序列化后的事件。
响应
void
属性
name
事件名称。
自 |
1.0 |
---|
类型
string
arguments
事件参数。
自 |
1.0 |
---|
类型
array<string|int, mixed>
stopped
一个标志,用于查看事件传播是否停止。
自 |
1.0 |
---|
类型
bool
constructed
一个标志,用于查看构造函数是否已被调用。
类型
bool