BeforeDisplayMethods
扩展 AbstractImmutableEventonUserMultifactorBeforeDisplayMethods 事件的具体事件类
| 自 |
4.2.0 |
|---|---|
| 包 |
Joomla CMS |
方法
__construct
公共构造函数
__construct(\Joomla\CMS\User\User user) :
addResult
将数据追加到事件的结果数组中。
addResult( data) :
| 自 |
4.2.0 |
|---|
参数
- data
mixed要添加到结果数组的内容。
响应
void
create
为给定的事件名称和主题创建新的 CMS 事件对象。必须提供以下参数：主题对象事件的主题。这是您要操作的核心对象。
create( eventName, mixed||string|int arguments = []) :
eventClass string 事件类名称。如果您没有提供，将使用 Joomla\CMS\Events<eventNameWithoutOnPrefix>。
| 自 |
4.0.0 |
|---|---|
| 抛出 |
|
参数
- eventName
string事件名称，例如 onTableBeforeLoad- arguments
array<string|int, mixed>要传递给事件的附加参数
响应
static
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
onSetResult
处理直接设置结果参数。
onSetResult(mixed||string|int value) : mixed||string|int
此方法具有双重目的：向后兼容性和强制使用 addResult。
当 $this->preventSetArgumentResult 为 false 时，它充当事件处理程序的向后兼容垫片，这些事件处理程序期望使用泛型事件类，而不是此包中实现的具体事件。这允许在 Joomla 4.x 的整个生命周期中将迁移到具体的事件类。
当 $this->preventSetArgumentResult 为 false 时（在 Joomla 5.0 上始终如此），如果开发人员尝试调用 setArgument('result', ...) 而不是通过 addResult() 方法，它将抛出 BadMethodCallException。
| 自 |
4.4.0 |
|---|
参数
- value
array<string|int, mixed>新的结果数组。
响应
array<string|int, mixed>
onSetUser
验证“user”命名参数的值
onSetUser(\Joomla\CMS\User\User value) : \Joomla\CMS\User\User
setArgument
将参数添加到事件中。
setArgument( name, value) :
如果存在，它将使用预处理方法。该方法具有以下签名
onSet<ArgumentName>($value): mixed
其中
$value 是用户正在设置的值 它返回要返回以在事件的 $arguments 数组中设置的值。
| 自 |
4.0.0 |
|---|
参数
- name
string参数名称。- value
mixed值。
响应
$this
setResult
处理直接设置结果参数。
setResult(mixed||string|int value) : mixed||string|int
此方法具有双重目的：向后兼容性和强制使用 addResult。
当 $this->preventSetArgumentResult 为 false 时，它充当事件处理程序的向后兼容垫片，这些事件处理程序期望使用泛型事件类，而不是此包中实现的具体事件。这允许在 Joomla 4.x 的整个生命周期中将迁移到具体的事件类。
当 $this->preventSetArgumentResult 为 false 时（在 Joomla 5.0 上始终如此），如果开发人员尝试调用 setArgument('result', ...) 而不是通过 addResult() 方法，它将抛出 BadMethodCallException。
| 自 |
4.2.0 |
|---|---|
| 已弃用 |
4.4.0 将在 6.0 中删除 使用带有 onSet 前缀的对应项 |
参数
- value
array<string|int, mixed>新的结果数组。
响应
array<string|int, mixed>
setUser
验证“user”命名参数的值
setUser(\Joomla\CMS\User\User value) : \Joomla\CMS\User\User
属性
eventNameToConcreteClass
将事件名称映射到具体的事件类。
这仅适用于事件名称不变的事件。具有可变名称的事件在 getEventClassByEventName 类中使用 PHP 逻辑处理。
| 自 |
4.2.0 |
|---|
类型
array<string|int, mixed>
constructed
一个标志，用于查看构造函数是否已被调用。
| 自 |
4.0.0 |
|---|
类型
bool
preventSetArgumentResult
不允许使用 setArgument() 而不是 addResult() 直接设置结果参数。
您应仅对在 Joomla 4.2.0 之前不存在的事件名称或如果您是第三方开发者为仅在您的软件中使用而引入新的事件名称，将此设置为 true。
| 自 |
4.2.0 |
|---|---|
| 已弃用 |
4.3 将在 6.0 中删除 对于结果参数，始终不允许使用 setResult()。 |
类型
bool