AuthenticationEvent
扩展 UserEvent用户事件的类。
示例：new AuthenticationEvent('onEventName', ['credentials' => $credentials, 'options' => $options, 'subject' => $authenticationResponse]);
| 自从 |
5.0.0 |
|---|---|
| 包 |
Joomla CMS |
方法
__construct
构造函数。
__construct( name, mixed||string|int arguments = []) :
| 抛出 |
|
|---|---|
| 自从 |
5.0.0 |
参数
- name
string事件名称。- arguments
array<string|int, mixed>事件参数。
响应
混合
create
为给定的事件名称和主题创建新的 CMS 事件对象。必须提供以下参数：主题对象事件的主题。这是您将要操作的核心对象。
create( eventName, mixed||string|int arguments = []) :
eventClass 字符串 事件类名称。如果您没有提供它，将使用 Joomla\CMS\Events<eventNameWithoutOnPrefix>。
| 自从 |
4.0.0 |
|---|---|
| 抛出 |
|
参数
- eventName
string事件的名称，例如 onTableBeforeLoad- arguments
array<string|int, mixed>传递给事件的附加参数
响应
静态
getArgument
获取事件参数值。
getArgument( name, default = null) :
如果存在，它将使用预处理方法。该方法具有签名
onGet<ArgumentName>($value): 混合
哪里
$value 是当前存储在事件的 $arguments 数组中的值 它返回要返回给调用者的值。
| 自从 |
4.0.0 |
|---|
参数
- name
string参数名称。- default
mixed如果未找到，则为默认值。
响应
mixed参数值或默认值。
getAuthenticationResponse
响应的 Getter。
getAuthenticationResponse() : \Joomla\CMS\Authentication\AuthenticationResponse
getCredentials
凭据的 Getter。
getCredentials() : mixed||string|int
| 自从 |
5.0.0 |
|---|
响应
array<string|int, mixed>
getEventClassByEventName
获取给定事件名称的具体事件类名称。
getEventClassByEventName( eventName) :
如果此特性不认识事件名称，此方法将回退到通用 Joomla\Event\Event 类。
| 自从 |
4.2.0 |
|---|
参数
- eventName
string事件名称
响应
string事件类名称
getOptions
选项的 Getter。
getOptions() : mixed||string|int
| 自从 |
5.0.0 |
|---|
响应
array<string|int, mixed>
isStopped
告诉事件传播是否已停止。
isStopped() :
此外，当 AuthenticationResponse 的 STATUS_SUCCESS 时，事件被认为已“停止”。
| 自从 |
5.0.0 |
|---|
响应
bool如果停止，则为 true，否则为 false。
offsetSet
设置事件参数的值。
offsetSet( name, value) :
| 自从 |
4.0.0 |
|---|---|
| 抛出 |
|
参数
- name
string参数名称。- value
mixed参数值。
响应
void
offsetUnset
删除事件参数。
offsetUnset( name) :
| 自从 |
4.0.0 |
|---|---|
| 抛出 |
|
参数
- name
string参数名称。
响应
void
onSetCredentials
凭据参数的 Setter。
onSetCredentials(mixed||string|int value) : mixed||string|int
| 自从 |
5.0.0 |
|---|
参数
- value
array<string|int, mixed>要设置的值
响应
array<string|int, mixed>
onSetOptions
选项参数的 Setter。
onSetOptions(mixed||string|int value) : mixed||string|int
| 自从 |
5.0.0 |
|---|
参数
- value
array<string|int, mixed>要设置的值
响应
array<string|int, mixed>
onSetSubject
主题参数的 Setter。
onSetSubject(\Joomla\CMS\Authentication\AuthenticationResponse value) : \Joomla\CMS\Authentication\AuthenticationResponse
reshapeArguments
重新整形参数数组以保留与旧版侦听器的 b/c
reshapeArguments(mixed||string|int arguments, mixed||string|int argumentNames, mixed||string|int defaults = []) : mixed||string|int
| 自从 |
4.2.0 |
|---|
参数
- arguments
array<string|int, mixed>传递给构造函数的命名参数数组。- argumentNames
array<string|int, mixed>允许的参数名称（强制和可选）。- defaults
array<string|int, mixed>可选参数的默认值。
响应
array<string|int, mixed>重新整形参数。
setArgument
将参数添加到事件。
setArgument( name, value) :
如果存在，它将使用预处理方法。该方法具有签名
onSet<ArgumentName>($value): 混合
哪里
$value 是用户设置的值 它返回要返回到事件的 $arguments 数组中设置的值。
| 自从 |
4.0.0 |
|---|
参数
- name
string参数名称。- value
mixed值。
响应
$this
属性
eventNameToConcreteClass
将事件名称映射到具体事件类。
这仅适用于具有不变名称的事件。具有可变名称的事件在 getEventClassByEventName 类中使用 PHP 逻辑处理。
| 自从 |
4.2.0 |
|---|
类型
array<string|int, mixed>
constructed
一个标志，用于查看构造函数是否已被调用。
| 自从 |
4.0.0 |
|---|
类型
bool
legacyArgumentsOrder
参数名称，按旧版插件期望的顺序。
| 自从 |
5.0.0 |
|---|---|
| 已弃用 |
5.0 将在 6.0 中删除 |
类型
array<string|int, mixed>