EditorButtonsSetupEvent
扩展 AbstractImmutableEvent编辑器设置事件
| 自 |
5.0.0 |
|---|---|
| 包 |
Joomla CMS |
方法
__construct
构造函数。
__construct( name, mixed||string|int arguments = []) :
| 抛出 |
|
|---|---|
| 自 |
5.0.0 |
参数
- name
string事件名称。- arguments
array<string|int, 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参数值或默认值。
getAsset
资产参数的 Getter。
getAsset() :
| 自 |
5.0.0 |
|---|
响应
int
getAuthor
作者参数的 Getter。
getAuthor() :
| 自 |
5.0.0 |
|---|
响应
int
getButtonsRegistry
返回按钮注册表实例。
getButtonsRegistry() : \Joomla\CMS\Editor\Button\ButtonsRegistryInterface
getDisabledButtons
禁用按钮参数的 Getter。
getDisabledButtons() : mixed||string|int
| 自 |
5.0.0 |
|---|
响应
array<string|int, mixed>
getEditorId
编辑器 ID 参数的 Getter。
getEditorId() :
| 自 |
5.0.0 |
|---|
响应
string
getEditorType
编辑器类型参数的 Getter。
getEditorType() :
| 自 |
5.0.0 |
|---|
响应
string
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
onSetAsset
资产参数的 Setter。
onSetAsset( value) :
| 自 |
5.0.0 |
|---|
参数
- value
int要设置的值
响应
int
onSetAuthor
作者参数的 Setter。
onSetAuthor( value) :
| 自 |
5.0.0 |
|---|
参数
- value
int要设置的值
响应
int
onSetDisabledButtons
禁用按钮参数的 Setter。
onSetDisabledButtons(mixed||string|int value) : mixed||string|int
| 自 |
5.0.0 |
|---|
参数
- value
array<string|int, mixed>要设置的值
响应
array<string|int, mixed>
onSetEditorId
编辑器 ID 参数的 Setter。
onSetEditorId( value) :
| 自 |
5.0.0 |
|---|
参数
- value
string要设置的值
响应
string
onSetEditorType
编辑器类型参数的 Setter。
onSetEditorType( value) :
| 自 |
5.0.0 |
|---|
参数
- value
string要设置的值
响应
string
onSetSubject
主题参数的 Setter。
onSetSubject(\Joomla\CMS\Editor\Button\ButtonsRegistryInterface value) : \Joomla\CMS\Editor\Button\ButtonsRegistryInterface
setArgument
将参数添加到事件。
setArgument( name, value) :
如果存在，它将使用预处理方法。该方法具有以下签名
onSet<ArgumentName>($value): mixed
在哪里
$value 是用户正在设置的值 它返回要返回到事件的 $arguments 数组中的值。
| 自 |
4.0.0 |
|---|
参数
- name
string参数名称。- value
mixed值。
响应
$this
属性
eventNameToConcreteClass
将事件名称映射到具体的 Event 类。
这仅适用于具有不变名称的事件。具有可变名称的事件在 getEventClassByEventName 类中使用 PHP 逻辑处理。
| 自 |
4.2.0 |
|---|
类型
array<string|int, mixed>
constructed
一个标志，用于查看构造函数是否已调用。
| 自 |
4.0.0 |
|---|
类型
bool