BeforePublishEvent
扩展 AbstractEvent\Joomla\CMS\Table\Table onBeforePublish 事件的事件类
| 自 |
4.0.0 |
|---|---|
| 包 |
Joomla CMS |
方法
__construct
构造函数。
__construct( name, mixed||string|int arguments = []) :
必填参数：subject \Joomla\CMS\Table\TableInterface 我们正在操作的表pks mixed 要更新的主键值可选数组。state int 发布状态。例如。[0 = 未发布，1 = 已发布]userId int 执行操作的用户 ID。
| 抛出 |
|
|---|
参数
- 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>要传递给事件的其他参数
响应
静态
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
onSetQuery
pks 参数的设置器
onSetQuery(array|null value) :
| 抛出 |
|
|---|---|
| 自 |
4.4.0 |
参数
- value
array<string|int, mixed>|null要设置的值
响应
mixed
onSetState
state 参数的设置器
onSetState( value) :
| 抛出 |
|
|---|---|
| 自 |
4.4.0 |
参数
- value
int要设置的值
响应
int
onSetSubject
subject 参数的设置器
onSetSubject(\Joomla\CMS\Table\TableInterface value) : \Joomla\CMS\Table\TableInterface
onSetUserId
userId 参数的设置器
onSetUserId( value) :
| 抛出 |
|
|---|---|
| 自 |
4.4.0 |
参数
- value
int要设置的值
响应
int
setArgument
将参数添加到事件。
setArgument( name, value) :
如果存在，它将使用预处理方法。该方法的签名为
onSet<ArgumentName>($value): mixed
哪里
$value 是用户正在设置的值 它返回要返回以设置在事件的 $arguments 数组中的值。
| 自 |
4.0.0 |
|---|
参数
- name
string参数名称。- value
mixed值。
响应
$this
setQuery
pks 参数的设置器
setQuery(array|null value) :
| 抛出 |
|
|---|---|
| 已弃用 |
4.4.0 将在 6.0 中删除 使用具有 onSet 前缀的对应方法 |
参数
- value
array<string|int, mixed>|null要设置的值
响应
mixed
setState
state 参数的设置器
setState( value) :
| 抛出 |
|
|---|---|
| 已弃用 |
4.4.0 将在 6.0 中删除 使用具有 onSet 前缀的对应方法 |
参数
- value
int要设置的值
响应
int
setSubject
subject 参数的设置器
setSubject(\Joomla\CMS\Table\TableInterface value) : \Joomla\CMS\Table\TableInterface
| 抛出 |
|
|---|---|
| 已弃用 |
4.4.0 将在 6.0 中删除 使用具有 onSet 前缀的对应方法 |
参数
- value
TableInterface要设置的值
响应
setUserId
userId 参数的设置器
setUserId( value) :
| 抛出 |
|
|---|---|
| 已弃用 |
4.4.0 将在 6.0 中删除 使用具有 onSet 前缀的对应方法 |
参数
- value
int要设置的值
响应
int
属性
eventNameToConcreteClass
将事件名称映射到具体事件类。
这仅适用于具有不变名称的事件。具有可变名称的事件在 getEventClassByEventName 类中使用 PHP 逻辑处理。
| 自 |
4.2.0 |
|---|
类型
array<string|int, mixed>
constructed
一个标志，用于查看构造函数是否已被调用。
| 自 |
4.0.0 |
|---|
类型
bool