AfterPrepareFieldEvent
扩展 AbstractPrepareFieldEvent自定义字段事件的类
| 自 |
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 = []) :
事件类字符串事件类名称。 如果您没有提供它，将使用 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参数值或默认值。
getContext
上下文的 Getter。
getContext() :
| 自 |
5.0.0 |
|---|
响应
字符串
getEventClassByEventName
获取给定事件名称的具体事件类名称。
getEventClassByEventName( eventName) :
如果此特性不知道事件名称，此方法将回退到通用 Joomla\Event\Event 类。
| 自 |
4.2.0 |
|---|
参数
- 事件名称
string事件名称
响应
string事件类名称
getField
字段的 Getter。
getField() :
| 自 |
5.0.0 |
|---|
响应
对象
getItem
项目的 Getter。
getItem() :
| 自 |
5.0.0 |
|---|
响应
对象
getValue
值的 Getter。
getValue() :
| 自 |
5.0.0 |
|---|
响应
混合
offsetSet
设置事件参数的值。
offsetSet( name, value) :
| 自 |
4.0.0 |
|---|---|
| 抛出 |
|
参数
- 名称
string参数名称。- 值
mixed参数值。
响应
无效
offsetUnset
删除事件参数。
offsetUnset( name) :
| 自 |
4.0.0 |
|---|---|
| 抛出 |
|
参数
- 名称
string参数名称。
响应
无效
onSetContext
上下文参数的 Setter。
onSetContext( value) :
| 自 |
5.0.0 |
|---|
参数
- 值
string要设置的值
响应
字符串
onSetItem
项目参数的 Setter。
onSetItem( value) :
| 自 |
5.0.0 |
|---|
参数
- 值
object要设置的值
响应
对象
onSetSubject
主题参数的 Setter。
onSetSubject( value) :
| 自 |
5.0.0 |
|---|
参数
- 值
object要设置的值
响应
对象
reshapeArguments
重塑参数数组以保留与旧版侦听器的 b/c
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
updateValue
更新值。
updateValue( value) :
| 自 |
5.0.0 |
|---|
参数
- 值
混合
响应
混合
属性
eventNameToConcreteClass
将事件名称映射到具体事件类。
这仅适用于具有不变名称的事件。 具有可变名称的事件由 getEventClassByEventName 类中的 PHP 逻辑处理。
| 自 |
4.2.0 |
|---|
类型
array<string|int, mixed>
已构造
一个标志，用于查看构造函数是否已调用。
| 自 |
4.0.0 |
|---|
类型
布尔值
legacyArgumentsOrder
参数名称，按旧版插件的预期顺序。
| 自 |
5.0.0 |
|---|---|
| 已弃用 |
5.0 将在 6.0 中删除 |
类型
array<string|int, mixed>