GetKeyEvent
扩展 PageCacheEvent 实现 ResultAwareInterface用于 PageCache 事件的类
| 自 |
5.1.0 |
|---|---|
| 包 |
Joomla CMS |
方法
__construct
构造函数。
__construct( name, mixed||string|int arguments = []) :
| 自 |
4.0.0 |
|---|---|
| 抛出 |
|
参数
- name
string事件名称。- arguments
array<string|int, mixed>事件参数。
响应
混合
addResult
将数据追加到事件的结果数组。
addResult( data) :
| 自 |
4.2.0 |
|---|
参数
- data
mixed要添加到结果数组的内容。
响应
空
create
为给定事件名称和主题创建一个新的 CMS 事件对象。必须给出以下参数：主题对象 事件的主题。这是您要操作的核心对象。
create( eventName, mixed||string|int arguments = []) :
eventClass string 事件类名称。如果您不提供它，将使用 Joomla\CMS\Events<eventNameWithoutOnPrefix>。
| 自 |
4.0.0 |
|---|---|
| 抛出 |
|
参数
- eventName
string事件名称，例如 onTableBeforeLoad- arguments
array<string|int, mixed>要传递给事件的附加参数
响应
静态
getArgument
获取事件参数值。
getArgument( name, default = null) :
如果存在预处理方法，它将使用该方法。该方法具有以下签名
onGet<ArgumentName>($value): mixed
其中
$value 是当前存储在事件的 $arguments 数组中的值 它将返回要返回给调用者的值。
| 自 |
4.0.0 |
|---|
参数
- name
string参数名称。- default
mixed如果未找到，则为默认值。
响应
mixed参数值或默认值。
getEventClassByEventName
获取给定事件名称的具体事件类名称。
getEventClassByEventName( eventName) :
如果该特性不认识事件名称，则此方法将回退到通用的 Joomla\Event\Event 类。
| 自 |
4.2.0 |
|---|
参数
- eventName
string事件名称
响应
string事件类名称
offsetSet
设置事件参数的值。
offsetSet( name, value) :
| 自 |
4.0.0 |
|---|---|
| 抛出 |
|
参数
- name
string参数名称。- value
mixed参数值。
响应
空
offsetUnset
删除事件参数。
offsetUnset( name) :
| 自 |
4.0.0 |
|---|---|
| 抛出 |
|
参数
- name
string参数名称。
响应
空
onSetResult
处理直接设置结果参数。
onSetResult(mixed||string|int value) : mixed||string|int
此方法具有双重目的：向后兼容性和强制使用 addResult。
当 $this->preventSetArgumentResult 为 false 时，它充当事件处理程序的向后兼容性垫片，这些事件处理程序期望使用通用的事件类，而不是此包中实现的具体 Events。这允许在 Joomla 4.x 的整个生命周期中将迁移到具体的事件类。
当 $this->preventSetArgumentResult 为 false 时（这在 Joomla 5.0 上始终为 true），如果开发人员尝试调用 setArgument('result', ...) 而不是通过 addResult() 方法，它将抛出 BadMethodCallException。
| 自 |
4.4.0 |
|---|
参数
- value
array<string|int, mixed>新的结果数组。
响应
array<string|int, mixed>
setArgument
将参数添加到事件。
setArgument( name, value) :
如果存在预处理方法，它将使用该方法。该方法具有以下签名
onSet<ArgumentName>($value): mixed
其中
$value 是用户设置的值 它将返回要返回以设置在事件的 $arguments 数组中的值。
| 自 |
4.0.0 |
|---|
参数
- name
string参数名称。- value
mixed值。
响应
$this
setResult
处理直接设置结果参数。
setResult(mixed||string|int value) : mixed||string|int
此方法具有双重目的：向后兼容性和强制使用 addResult。
当 $this->preventSetArgumentResult 为 false 时，它充当事件处理程序的向后兼容性垫片，这些事件处理程序期望使用通用的事件类，而不是此包中实现的具体 Events。这允许在 Joomla 4.x 的整个生命周期中将迁移到具体的事件类。
当 $this->preventSetArgumentResult 为 false 时（这在 Joomla 5.0 上始终为 true），如果开发人员尝试调用 setArgument('result', ...) 而不是通过 addResult() 方法，它将抛出 BadMethodCallException。
| 自 |
4.2.0 |
|---|---|
| 已弃用 |
4.4.0 将在 6.0 中删除 使用带有 onSet 前缀的对应项 |
参数
- value
array<string|int, mixed>新的结果数组。
响应
array<string|int, mixed>
属性
eventNameToConcreteClass
将事件名称映射到具体的 Event 类。
这仅适用于事件名称不变的事件。具有可变名称的事件由 getEventClassByEventName 类中的 PHP 逻辑处理。
| 自 |
4.2.0 |
|---|
类型
array<string|int, mixed>
constructed
一个标志，用于查看构造函数是否已调用。
| 自 |
4.0.0 |
|---|
类型
bool
resultIsNullable
结果属性值也可以为 NULL 吗？
| 自 |
4.2.0 |
|---|
类型
bool
resultIsFalseable
结果属性值也可以为布尔值 FALSE 吗？
| 自 |
4.2.0 |
|---|---|
| 已弃用 |
4.3 将在 6.0 中删除 您应该使用可空值或异常，而不是返回布尔值 false 结果。 |
类型
bool
preventSetArgumentResult
禁止使用 setArgument() 直接设置结果参数，而不是通过 addResult() 进行设置。
您应该仅对在 Joomla 4.2.0 之前不存在的事件名称或您是第三方开发者并引入新的事件名称以供您自己的软件使用的事件名称设置此值。
| 自 |
4.2.0 |
|---|---|
| 已弃用 |
4.3 将在 6.0 中删除 使用 setResult() 设置结果参数将始终被禁止。 |
类型
bool