AbstractLogoutEvent
扩展自 UserEvent用户注销事件的基础类
| 自版本 |
5.0.0 |
|---|---|
| 包 |
Joomla CMS |
方法
__construct
构造函数。
__construct( name, mixed||string|int arguments = []) :
| 抛出 |
|
|---|---|
| 自版本 |
5.0.0 |
参数
- 名称
string事件名称。- 参数
array<string|int, mixed>事件参数。
响应
混合
create
为给定的事件名称和主题创建一个新的 CMS 事件对象。必须提供以下参数：主题对象事件的主题。这是您将要操作的核心对象。
create( eventName, mixed||string|int arguments = []) :
eventClass 字符串事件类名称。如果您不提供，将使用 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事件类名称
getOptions
选项的 Getter。
getOptions() : mixed||string|int
| 自版本 |
5.0.0 |
|---|
响应
array<string|int, mixed>
getParameters
参数的 Getter。
getParameters() : mixed||string|int
| 自版本 |
5.0.0 |
|---|
响应
array<string|int, mixed>
offsetSet
设置事件参数的值。
offsetSet( name, value) :
| 自版本 |
4.0.0 |
|---|---|
| 抛出 |
|
参数
- 名称
string参数名称。- 值
mixed参数值。
响应
空
offsetUnset
删除事件参数。
offsetUnset( name) :
| 自版本 |
4.0.0 |
|---|---|
| 抛出 |
|
参数
- 名称
string参数名称。
响应
空
onSetOptions
选项参数的 Setter。
onSetOptions(mixed||string|int value) : mixed||string|int
| 自版本 |
5.0.0 |
|---|
参数
- 值
array<string|int, mixed>要设置的值
响应
array<string|int, mixed>
onSetSubject
主题参数的 Setter。
onSetSubject(mixed||string|int value) : mixed||string|int
| 自版本 |
5.0.0 |
|---|
参数
- 值
array<string|int, mixed>要设置的值
响应
array<string|int, mixed>
reshapeArguments
重塑参数数组以保留与旧版侦听器的兼容性
reshapeArguments(mixed||string|int arguments, mixed||string|int argumentNames, mixed||string|int defaults = []) : mixed||string|int
| 自版本 |
4.2.0 |
|---|
参数
- 参数
array<string|int, mixed>传递给构造函数的命名参数数组。- 参数名称
array<string|int, mixed>允许的参数名称（强制和可选）。- 默认值
array<string|int, mixed>可选参数的默认值。
响应
array<string|int, mixed>重塑后的参数。
setArgument
向事件添加参数。
setArgument( name, value) :
如果存在，它将使用预处理方法。该方法具有以下签名
onSet<ArgumentName>($value): mixed
其中
$value 是用户设置的值 它返回要返回到事件的 $arguments 数组中设置的值。
| 自版本 |
4.0.0 |
|---|
参数
- 名称
string参数名称。- 值
mixed值。
响应
$this
属性
eventNameToConcreteClass
将事件名称映射到具体的事件类。
这仅适用于具有不变名称的事件。具有可变名称的事件在 getEventClassByEventName 类中使用 PHP 逻辑处理。
| 自版本 |
4.2.0 |
|---|
类型(s)
array<string|int, mixed>
已构造
一个标志，用于查看是否已调用构造函数。
| 自版本 |
4.0.0 |
|---|
类型(s)
布尔值
legacyArgumentsOrder
参数名称，按旧版插件所需的顺序排列。
| 自版本 |
5.0.0 |
|---|---|
| 已弃用 |
5.0 将在 6.0 中删除 |
类型(s)
array<string|int, mixed>