PrepareDataEvent
扩展 AbstractImmutableEventSchemaPrepareDataEvent 事件的类示例：new PrepareDataEvent('onSchemaPrepareData', ['subject' => $data, 'context' => 'com_example.example']);
| 自 |
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 |
|---|---|
| 抛出 |
|
参数
- eventName
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 |
|---|
响应
字符串
getData
数据参数的 getter。
getData() :
| 自 |
5.0.0 |
|---|
响应
对象
getEventClassByEventName
获取给定事件名称的具体事件类名。
getEventClassByEventName( eventName) :
如果此特征未知事件名称，此方法将回退到通用 Joomla\Event\Event 类。
| 自 |
4.2.0 |
|---|
参数
- eventName
string事件名称
响应
string事件类名
offsetSet
设置事件参数的值。
offsetSet( name, value) :
| 自 |
4.0.0 |
|---|---|
| 抛出 |
|
参数
- 名称
string参数名称。- 值
mixed参数值。
响应
空
offsetUnset
删除事件参数。
offsetUnset( name) :
| 自 |
4.0.0 |
|---|---|
| 抛出 |
|
参数
- 名称
string参数名称。
响应
空
onSetContext
上下文参数的 setter。
onSetContext( value) :
| 自 |
5.0.0 |
|---|
参数
- 值
string要设置的值
响应
字符串
onSetSubject
主题参数的 setter。
onSetSubject( value) :
| 自 |
5.0.0 |
|---|
参数
- 值
object要设置的值
响应
对象
setArgument
向事件添加参数。
setArgument( name, value) :
如果存在，它将使用预处理方法。该方法具有签名
onSet<ArgumentName>($value): mixed
哪里
$value 是用户正在设置的值 它返回要返回到事件的 $arguments 数组中的值。
| 自 |
4.0.0 |
|---|
参数
- 名称
string参数名称。- 值
mixed值。
响应
$this
属性
eventNameToConcreteClass
将事件名称映射到具体事件类。
这仅适用于事件名称不变的事件。事件名称可变的事件在 getEventClassByEventName 类中使用 PHP 逻辑进行处理。
| 自 |
4.2.0 |
|---|
类型
array<string|int, mixed>
构造
一个标志，用于查看构造函数是否已被调用。
| 自 |
4.0.0 |
|---|
类型
布尔