PrepareFieldEvent
扩展 AbstractPrepareFieldEvent 实现 ResultAwareInterface自定义字段事件的类
| 自 |
5.0.0 |
|---|---|
| 包 |
Joomla CMS |
方法
__construct
构造函数。
__construct( name, mixed||string|int arguments = []) :
| 抛出 |
|
|---|---|
| 自 |
5.0.0 |
参数
- name
string事件名称。- arguments
array<string|int, mixed>事件参数。
响应
mixed
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>传递给事件的其他参数
响应
静态
getArgument
获取事件参数值。
getArgument( name, default = null) :
如果存在，它将使用预处理方法。该方法具有签名
onGet<ArgumentName>($value): mixed
其中
$value 是事件的 $arguments 数组中当前存储的值 它返回要返回给调用者的值。
| 自 |
4.0.0 |
|---|
参数
- name
string参数名称。- default
mixed如果未找到，则为默认值。
响应
mixed参数值或默认值。
getContext
上下文获取器。
getContext() :
| 自 |
5.0.0 |
|---|
响应
string
getEventClassByEventName
获取给定事件名称的具体事件类名称。
getEventClassByEventName( eventName) :
如果事件名称对此特性未知，则此方法将回退到通用 Joomla\Event\Event 类。
| 自 |
4.2.0 |
|---|
参数
- eventName
string事件名称
响应
string事件类名称
getField
字段获取器。
getField() :
| 自 |
5.0.0 |
|---|
响应
object
getItem
项获取器。
getItem() :
| 自 |
5.0.0 |
|---|
响应
object
offsetSet
设置事件参数的值。
offsetSet( name, value) :
| 自 |
4.0.0 |
|---|---|
| 抛出 |
|
参数
- name
string参数名称。- value
mixed参数值。
响应
void
offsetUnset
移除事件参数。
offsetUnset( name) :
| 自 |
4.0.0 |
|---|---|
| 抛出 |
|
参数
- name
string参数名称。
响应
void
onSetContext
上下文参数设置器。
onSetContext( value) :
| 自 |
5.0.0 |
|---|
参数
- value
string要设置的值
响应
string
onSetItem
项参数设置器。
onSetItem( value) :
| 自 |
5.0.0 |
|---|
参数
- value
object要设置的值
响应
object
onSetResult
处理直接设置结果参数。
onSetResult(mixed||string|int value) : mixed||string|int
此方法具有双重用途：向后兼容性和强制使用 addResult。
当 $this->preventSetArgumentResult 为 false 时，它充当事件处理程序的向后兼容垫片，这些事件处理程序期望使用通用事件类而不是此包中实现的具体 Events。这允许在 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>
onSetSubject
主题参数设置器。
onSetSubject( value) :
| 自 |
5.0.0 |
|---|
参数
- value
object要设置的值
响应
object
reshapeArguments
重塑参数数组以保留与旧版监听器的兼容性
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): mixed
其中
$value 是用户设置的值 它返回要返回到事件的 $arguments 数组中设置的值。
| 自 |
4.0.0 |
|---|
参数
- name
string参数名称。- value
mixed值。
响应
$this
setResult
处理直接设置结果参数。
setResult(mixed||string|int value) : mixed||string|int
此方法具有双重用途：向后兼容性和强制使用 addResult。
当 $this->preventSetArgumentResult 为 false 时，它充当事件处理程序的向后兼容垫片，这些事件处理程序期望使用通用事件类而不是此包中实现的具体 Events。这允许在 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>
属性
eventNameToConcreteClass
将事件名称映射到具体的事件类。
这仅适用于名称不变的事件。名称可变的事件在 getEventClassByEventName 类中使用 PHP 逻辑进行处理。
| 自 |
4.2.0 |
|---|
类型(s)
array<string|int, mixed>
构造
一个标志，用于查看构造函数是否已被调用。
| 自 |
4.0.0 |
|---|
类型(s)
bool
legacyArgumentsOrder
参数名称，按旧版插件所需的顺序排列。
| 自 |
5.0.0 |
|---|---|
| 已弃用 |
5.0 将在 6.0 中移除 |
类型(s)
array<string|int, mixed>
preventSetArgumentResult
不允许使用 setArgument() 直接设置结果参数，而是通过 addResult() 进行设置。
您应该仅对在 Joomla 4.2.0 之前不存在的事件名称或您是引入仅在您的软件中使用的新的事件名称的第三方开发者时，将此设置为 true。
| 自 |
4.2.0 |
|---|---|
| 已弃用 |
4.3 将在 6.0 中移除 使用 setResult() 设置结果参数将始终被禁止。 |
类型(s)
bool