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