PreprocessMenuItemsEvent
扩展 AbstractImmutableEvent菜单事件的类
| 自 |
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
上下文属性的获取器。
getContext() :
| 自 |
5.0.0 |
|---|
响应
字符串
getEnabled
enabled 属性的获取器。
getEnabled() : bool
| 自 |
5.0.0 |
|---|
响应
bool|null
getEventClassByEventName
获取给定事件名称的具体事件类名。
getEventClassByEventName( eventName) :
如果此特性不认识事件名称，此方法将回退到通用的 Joomla\Event\Event 类。
| 自 |
4.2.0 |
|---|
参数
- eventName
string事件名称
响应
string事件类名
getItems
items 属性的获取器。
getItems() : \Joomla\CMS\Menu\MenuItem||string|int
getParams
params 属性的获取器。
getParams() : \Joomla\Registry\Registry
| 自 |
5.0.0 |
|---|
响应
Registry|null
offsetSet
设置事件参数的值。
offsetSet( name, value) :
| 自 |
4.0.0 |
|---|---|
| 抛出 |
|
参数
- 名称
string参数名称。- 值
mixed参数值。
响应
void
offsetUnset
删除事件参数。
offsetUnset( name) :
| 自 |
4.0.0 |
|---|---|
| 抛出 |
|
参数
- 名称
string参数名称。
响应
void
onSetContext
context 参数的设置器。
onSetContext( value) :
| 自 |
5.0.0 |
|---|
参数
- 值
string要设置的值
响应
字符串
onSetEnabled
enabled 参数的设置器。
onSetEnabled(bool value) : bool
| 自 |
5.0.0 |
|---|
参数
- 值
bool|null要设置的值
响应
bool|null
onSetParams
registry 参数的设置器。
onSetParams(\Joomla\Registry\Registry value) : \Joomla\Registry\Registry
| 自 |
5.0.0 |
|---|
参数
- 值
Registry|null要设置的值
响应
Registry|null
onSetSubject
subject 参数的设置器。
onSetSubject(\Joomla\CMS\Menu\MenuItem||string|int value) : \Joomla\CMS\Menu\MenuItem||string|int
reshapeArguments
重塑参数数组以保留与旧式侦听器的向后兼容性
reshapeArguments(mixed||string|int arguments, mixed||string|int argumentNames, mixed||string|int defaults = []) : mixed||string|int
| 自 |
4.2.0 |
|---|
参数
- 参数
array<string|int, mixed>传递给构造函数的命名参数数组。- argumentNames
array<string|int, mixed>允许的参数名称（强制性和可选）。- defaults
array<string|int, mixed>可选参数的默认值。
响应
array<string|int, mixed>重塑后的参数。
setArgument
将参数添加到事件。
setArgument( name, value) :
如果存在，它将使用预处理方法。该方法的签名为
onSet<ArgumentName>($value): mixed
哪里
$value 是用户正在设置的值 它返回要返回到事件的 $arguments 数组中设置的值。
| 自 |
4.0.0 |
|---|
参数
- 名称
string参数名称。- 值
mixed值。
响应
$this
updateItems
更新项目。
updateItems(\Joomla\CMS\Menu\MenuItem||string|int value) :
属性
eventNameToConcreteClass
将事件名称映射到具体事件类。
这仅适用于名称不变的事件。具有可变名称的事件由 getEventClassByEventName 类的 PHP 逻辑处理。
| 自 |
4.2.0 |
|---|
类型(s)
array<string|int, mixed>
constructed
一个标志，用于查看构造函数是否已被调用。
| 自 |
4.0.0 |
|---|
类型(s)
bool
legacyArgumentsOrder
旧式插件期望的顺序的参数名称。
| 自 |
5.0.0 |
|---|---|
| 已弃用 |
5.0 将在 6.0 中删除 |
类型(s)
array<string|int, mixed>