NotifyActionLog
扩展自 AbstractImmutableEvent用于自定义事件的具体事件类,用于通知用户操作日志插件关于双因素身份验证操作。
自版本 |
4.2.0 |
---|---|
包 |
Joomla CMS |
方法
__construct
公共构造函数
__construct( name, mixed||string|int arguments = []) :
自版本 |
4.2.0 |
---|
参数
- name
string
事件名称。必须属于 self::ACCEPTABLE_EVENTS- arguments
array<string|int, mixed>
事件参数(每个事件的参数不同)。
响应
mixed
create
为给定的事件名称和主题创建一个新的 CMS 事件对象。必须提供以下参数:subject 对象 事件的主题。这是您要操作的核心对象。
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
参数值。
响应
void
offsetUnset
移除事件参数。
offsetUnset( name) :
自版本 |
4.0.0 |
---|---|
抛出 |
|
参数
- name
string
参数名称。
响应
void
setArgument
向事件添加参数。
setArgument( name, value) :
如果存在,它将使用预处理方法。该方法的签名为
onSet<ArgumentName>($value): mixed
其中
$value 是用户设置的值 它返回要返回到事件的 $arguments 数组中设置的值。
自版本 |
4.0.0 |
---|
参数
- name
string
参数名称。- value
mixed
值。
响应
$this
常量
ACCEPTABLE_EVENTS
值 | ['onComUsersCaptiveValidateSuccess', 'onComUsersViewMethodsAfterDisplay', 'onComUsersCaptiveShowCaptive', 'onComUsersCaptiveShowSelect', 'onComUsersCaptiveValidateFailed', 'onComUsersCaptiveValidateInvalidMethod', 'onComUsersCaptiveValidateTryLimitReached', 'onComUsersCaptiveValidateSuccess', 'onComUsersControllerMethodAfterRegenerateBackupCodes', 'onComUsersControllerMethodBeforeAdd', 'onComUsersControllerMethodBeforeDelete', 'onComUsersControllerMethodBeforeEdit', 'onComUsersControllerMethodBeforeSave', 'onComUsersControllerMethodsBeforeDisable', 'onComUsersControllerMethodsBeforeDoNotShowThisAgain'] |
---|
属性
eventNameToConcreteClass
将事件名称映射到具体的事件类。
这仅适用于具有不变名称的事件。具有可变名称的事件在 getEventClassByEventName 类中使用 PHP 逻辑处理。
自版本 |
4.2.0 |
---|
类型(s)
array<string|int, mixed>
constructed
一个标志,用于查看构造函数是否已被调用。
自版本 |
4.0.0 |
---|
类型(s)
bool