PrepareSaveEvent
扩展 AbstractImmutableEventSchemaPrepareSaveEvent 事件的类示例：new PrepareFormEvent('onSchemaPrepareForm', ['subject' => $subject, 'context' => $context, 'item' => $table, 'isNew' => $isNew, 'schema' => $schema]);
| 自 |
5.0.0 |
|---|---|
| 包 |
Joomla CMS |
方法
__construct
构造函数。
__construct( name, mixed||string|int arguments = []) :
| 抛出 |
|
|---|---|
| 自 |
5.0.0 |
参数
- name
string事件名称。- arguments
array<string|int, mixed>事件参数。
响应
mixed
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
context 参数的 Getter。
getContext() :
| 自 |
5.0.0 |
|---|
响应
string
getData
data 参数的 Getter。
getData() :
| 自 |
5.0.0 |
|---|
响应
object
getEventClassByEventName
获取给定事件名称的具体事件类名称。
getEventClassByEventName( eventName) :
如果该事件名称对该特性未知，则该方法将回退到通用的 Joomla\Event\Event 类。
| 自 |
4.2.0 |
|---|
参数
- eventName
string事件名称
响应
string事件类名称
getIsNew
isNew 参数的 Getter。
getIsNew() :
| 自 |
5.0.0 |
|---|
响应
bool
getSchema
schema 参数的 Getter。
getSchema() : mixed||string|int
| 自 |
5.0.0 |
|---|
响应
array<string|int, mixed>
offsetSet
设置事件参数的值。
offsetSet( name, value) :
| 自 |
4.0.0 |
|---|---|
| 抛出 |
|
参数
- name
string参数名称。- value
mixed参数值。
响应
void
offsetUnset
删除事件参数。
offsetUnset( name) :
| 自 |
4.0.0 |
|---|---|
| 抛出 |
|
参数
- name
string参数名称。
响应
void
onSetContext
context 参数的 Setter。
onSetContext( value) :
| 自 |
5.0.0 |
|---|
参数
- value
string要设置的值
响应
string
onSetIsNew
isNew 参数的 Setter。
onSetIsNew( value) :
| 自 |
5.0.0 |
|---|
参数
- value
bool要设置的值
响应
bool
onSetItem
item 参数的 Setter。
onSetItem(\Joomla\CMS\Table\TableInterface value) : \Joomla\CMS\Table\TableInterface
onSetSchema
schema 参数的 Setter。
onSetSchema(mixed||string|int value) : mixed||string|int
| 自 |
5.0.0 |
|---|
参数
- value
array<string|int, mixed>要设置的值
响应
array<string|int, mixed>
onSetSubject
subject 参数的 Setter。
onSetSubject( value) :
| 自 |
5.0.0 |
|---|
参数
- value
object要设置的值
响应
object
setArgument
向事件添加参数。
setArgument( name, value) :
如果存在，它将使用预处理方法。该方法的签名为
onSet<ArgumentName>($value): mixed
其中
$value 是用户正在设置的值它返回要返回到事件的 $arguments 数组中设置的值。
| 自 |
4.0.0 |
|---|
参数
- name
string参数名称。- value
mixed值。
响应
$this
属性
eventNameToConcreteClass
将事件名称映射到具体事件类。
这仅适用于事件名称不变的事件。使用 PHP 逻辑在 getEventClassByEventName 类中处理具有可变名称的事件。
| 自 |
4.2.0 |
|---|
类型
array<string|int, mixed>
constructed
一个标志，用于查看构造函数是否已调用。
| 自 |
4.0.0 |
|---|
类型
bool