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