SetNewTagsEvent
扩展 AbstractEvent\Joomla\CMS\Table\Table onSetNewTags 事件的事件类
自 |
4.0.0 |
---|---|
待办事项 |
仅在 JModelAdmin::batchTag 中使用,因为我们不能使用 \Joomla\CMS\Table\Table::save,因为我们不想保存数据。也许应该触发 onBeforeStore? |
包 |
Joomla CMS |
方法
__construct
构造函数。
__construct( name, mixed||string|int arguments = []) :
必需参数:subject \Joomla\CMS\Table\TableInterface 我们正在操作的表格 newTags int[] 要添加到项目中的新标签或替换项目当前标签 replaceTags bool 替换标签(true)或添加它们(false)
抛出 |
|
---|
参数
- 名称
string
事件名称。- 参数
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- 参数
array<string|int, mixed>
传递给事件的额外参数
响应
static
getArgument
获取事件参数值。
getArgument( name, default = null) :
如果存在,它将使用预处理方法。该方法具有以下签名
onGet<ArgumentName>($value): mixed
其中
$value 是当前存储在事件的 $arguments 数组中的值 它返回要返回给调用者的值。
自 |
4.0.0 |
---|
参数
- 名称
string
参数名称。- 默认
mixed
如果未找到,则为默认值。
响应
mixed
参数值或默认值。
getEventClassByEventName
获取给定事件名称的具体事件类名称。
getEventClassByEventName( eventName) :
如果此特性不知道事件名称,此方法将回退到通用的 Joomla\Event\Event 类。
自 |
4.2.0 |
---|
参数
- eventName
string
事件名称
响应
string
事件类名称
offsetSet
设置事件参数的值。
offsetSet( name, value) :
自 |
4.0.0 |
---|---|
抛出 |
|
参数
- 名称
string
参数名称。- 值
mixed
参数值。
响应
void
offsetUnset
移除事件参数。
offsetUnset( name) :
自 |
4.0.0 |
---|---|
抛出 |
|
参数
- 名称
string
参数名称。
响应
void
onSetReplaceTags
replaceTags 属性的 Setter
onSetReplaceTags( value) :
自 |
4.4.0 |
---|
参数
- 值
mixed
要设置的值
响应
bool
标准化值
onSetSubject
主题参数的 Setter
onSetSubject(\Joomla\CMS\Table\TableInterface value) : \Joomla\CMS\Table\TableInterface
setArgument
将参数添加到事件。
setArgument( name, value) :
如果存在,它将使用预处理方法。该方法具有以下签名
onSet<ArgumentName>($value): mixed
其中
$value 是用户正在设置的值 它返回要返回以在事件的 $arguments 数组中设置的值。
自 |
4.0.0 |
---|
参数
- 名称
string
参数名称。- 值
mixed
值。
响应
$this
setReplaceTags
replaceTags 属性的 Setter
setReplaceTags( value) :
已弃用 |
4.4.0 将在 6.0 中删除 使用带有 onSet 前缀的对应项 |
---|
参数
- 值
mixed
要设置的值
响应
bool
标准化值
setSubject
主题参数的 Setter
setSubject(\Joomla\CMS\Table\TableInterface value) : \Joomla\CMS\Table\TableInterface
抛出 |
|
---|---|
已弃用 |
4.4.0 将在 6.0 中删除 使用带有 onSet 前缀的对应项 |
参数
- 值
TableInterface
要设置的值
响应
属性
eventNameToConcreteClass
将事件名称映射到具体的事件类。
这仅适用于名称不变的事件。具有可变名称的事件在 getEventClassByEventName 类中使用 PHP 逻辑进行处理。
自 |
4.2.0 |
---|
类型
array<string|int, mixed>
constructed
一个标志,用于查看构造函数是否已经被调用。
自 |
4.0.0 |
---|
类型
bool