Joomla! API

下载
启动

Captive

扩展自 AbstractImmutableEvent 实现 ResultAwareInterface

onUserMultifactorCaptive 事件的具体事件类

自

4.2.0
包

Joomla CMS

方法

__construct

公有构造函数

__construct(\Joomla\Component\Users\Administrator\Table\MfaTable record) :
自

4.2.0

参数

record

MfaTable在俘获登录页面中使用的 MFA 记录

响应

混合

addResult

将数据追加到事件的结果数组中。

addResult( data) :
继承
自

4.2.0

参数

data

混合要添加到结果数组的内容。

响应

空

create

为给定的事件名称和主题创建新的 CMS 事件对象。必须提供以下参数： 主题对象 事件的主题。这是你要操作的核心对象。

create( eventName, mixed||string|int arguments = []) :
继承 static

eventClass 字符串 事件类名称。如果你没有提供，将使用 Joomla\CMS\Events<eventNameWithoutOnPrefix>。

自

4.0.0
抛出

BadMethodCallException如果你没有提供主题参数

参数

eventName

字符串事件名称，例如 onTableBeforeLoad

arguments

array<字符串|整数, 混合>要传递给事件的其他参数

响应

static

getArgument

获取事件参数值。

getArgument( name,  default = null) :
继承

如果存在，它将使用预处理方法。该方法的签名为

onGet<ArgumentName>($value): 混合

其中

$value 是当前存储在事件 $arguments 数组中的值 它返回要返回给调用者的值。

自

4.0.0

参数

name

字符串参数名称。

default

混合如果未找到，则为默认值。

响应

混合参数值或默认值。

getEventClassByEventName

获取给定事件名称的具体事件类名称。

getEventClassByEventName( eventName) :
继承 static

如果此特性的事件名称未知，此方法将回退到通用的 Joomla\Event\Event 类。

自

4.2.0

参数

eventName

字符串事件名称

响应

字符串事件类名称

offsetSet

设置事件参数的值。

offsetSet( name,  value) :
继承
自

4.0.0
抛出

BadMethodCallException

参数

name

字符串参数名称。

value

混合参数值。

响应

空

offsetUnset

删除事件参数。

offsetUnset( name) :
继承
自

4.0.0
抛出

BadMethodCallException

参数

name

字符串参数名称。

响应

空

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 为假时，它充当事件处理程序的向后兼容垫片，这些事件处理程序期望使用通用的事件类，而不是此包中实现的具体 Events。这允许在 Joomla 4.x 的生命周期内将迁移到具体的事件类。

当 $this->preventSetArgumentResult 为假时（在 Joomla 5.0 上始终如此），如果开发者尝试调用 setArgument('result', ...) 而不是通过 addResult() 方法，它将抛出 BadMethodCallException。

自

4.4.0

参数

value

array<字符串|整数, 混合>新的结果数组。

响应

array<字符串|整数, 混合>

setArgument

将参数添加到事件。

setArgument( name,  value) :
继承

如果存在，它将使用预处理方法。该方法的签名为

onSet<ArgumentName>($value): 混合

其中

$value 是用户设置的值 它返回要返回给事件 $arguments 数组中的值。

自

4.0.0

参数

name

字符串参数名称。

value

混合值。

响应

$this

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 为假时，它充当事件处理程序的向后兼容垫片，这些事件处理程序期望使用通用的事件类，而不是此包中实现的具体 Events。这允许在 Joomla 4.x 的生命周期内将迁移到具体的事件类。

当 $this->preventSetArgumentResult 为假时（在 Joomla 5.0 上始终如此），如果开发者尝试调用 setArgument('result', ...) 而不是通过 addResult() 方法，它将抛出 BadMethodCallException。

自

4.2.0
已弃用

4.4.0 将在 6.0 中删除 使用具有 onSet 前缀的对应项

参数

value

array<字符串|整数, 混合>新的结果数组。

响应

array<字符串|整数, 混合>

属性

eventNameToConcreteClass

将事件名称映射到具体的事件类。

继承 static

这仅适用于具有不变名称的事件。具有可变名称的事件在 getEventClassByEventName 类中使用 PHP 逻辑进行处理。

自

4.2.0

类型

array<字符串|整数, 混合>

constructed

一个标志，用于查看构造函数是否已被调用。

继承
自

4.0.0

类型

布尔

resultIsNullable

结果属性值是否也可以为 NULL？

继承
自

4.2.0

类型

布尔

resultIsFalseable

结果属性值是否也可以为布尔值 FALSE？

继承 已弃用
自

4.2.0
已弃用

4.3 将在 6.0 中删除 你应该使用可空值或异常，而不是返回布尔值 false 结果。

类型

布尔

resultAcceptableClasses

结果值可接受的类名称。

继承
自

4.2.0

类型

array<字符串|整数, 混合>

preventSetArgumentResult

禁止使用 setArgument() 直接设置结果参数，而应通过 addResult() 进行设置。

继承 已弃用

你应该仅对在 Joomla 4.2.0 之前不存在的事件名称设置此值，或者如果你是一个第三方开发者，引入了仅在你自己的软件中使用的新的事件名称。

自

4.2.0
已弃用

4.3 将在 6.0 中删除 使用 setResult() 设置结果参数将始终被禁止。

类型

布尔
  • \ Joomla
  • \ CMS
  • \ Event
  • \ MultiFactor
  • \ Captive