BeforeLoadEvent
扩展 AbstractEvent用于 \Joomla\CMS\Table\Table onBeforeLoad 事件的事件类
| 自 |
4.0.0 |
|---|---|
| 包 |
Joomla CMS |
方法
__construct
构造函数。
__construct( name, mixed||string|int arguments = []) :
必需参数：subject \Joomla\CMS\Table\TableInterface 我们正在操作的表格 keys mixed 用于加载行的可选主键值，或要匹配的字段数组。 reset boolean 在加载新行之前，是否重置默认值。
| 抛出 |
|
|---|
参数
- name
string事件名称。- arguments
array<string|int, mixed>事件参数。
响应
mixed
create
为给定事件名称和主题创建一个新的 CMS 事件对象。必须提供以下参数：subject object 事件的主题。这是您要操作的核心对象。
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
onSetReset
reset 属性的 setter
onSetReset( value) :
| 自 |
4.4.0 |
|---|
参数
- value
mixed要设置的值
响应
bool规范化值
onSetSubject
subject 参数的 setter
onSetSubject(\Joomla\CMS\Table\TableInterface value) : \Joomla\CMS\Table\TableInterface
setArgument
将参数添加到事件。
setArgument( name, value) :
如果存在，它将使用预处理方法。该方法的签名是
onSet<ArgumentName>($value): mixed
其中
$value 是用户正在设置的值 它将返回值以返回到事件的 $arguments 数组中。
| 自 |
4.0.0 |
|---|
参数
- name
string参数名称。- value
mixed值。
响应
$this
setReset
reset 属性的 setter
setReset( value) :
| 已弃用 |
4.4.0 将在 6.0 中删除 使用带有 onSet 前缀的对应项 |
|---|
参数
- value
mixed要设置的值
响应
bool规范化值
setSubject
subject 参数的 setter
setSubject(\Joomla\CMS\Table\TableInterface value) : \Joomla\CMS\Table\TableInterface
| 抛出 |
|
|---|---|
| 已弃用 |
4.4.0 将在 6.0 中删除 使用带有 onSet 前缀的对应项 |
参数
- value
TableInterface要设置的值
响应
属性
eventNameToConcreteClass
将事件名称映射到具体的事件类。
这仅适用于具有不变名称的事件。具有可变名称的事件由 getEventClassByEventName 类的 PHP 逻辑处理。
| 自 |
4.2.0 |
|---|
类型
array<string|int, mixed>
constructed
一个标志，用于查看构造函数是否已被调用。
| 自 |
4.0.0 |
|---|
类型
bool