AfterInitialiseDocumentEvent
扩展 ApplicationDocumentEventAfterInitialiseDocument 事件的事件类
| 自 |
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 |
|---|---|
| 抛出 |
|
参数
- 事件名称
string事件名称，例如 onTableBeforeLoad- 参数
array<string|int, mixed>传递给事件的附加参数
响应
静态
getApplication
获取事件的应用程序对象
getApplication() : \Joomla\Application\AbstractApplication
| 自 |
5.0.0 |
|---|
响应
AbstractApplication
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 |
|---|
参数
- 事件名称
string事件名称
响应
string事件类名称
offsetSet
设置事件参数的值。
offsetSet( name, value) :
| 自 |
4.0.0 |
|---|---|
| 抛出 |
|
参数
- 名称
string参数名称。- 值
mixed参数值。
响应
空
offsetUnset
删除事件参数。
offsetUnset( name) :
| 自 |
4.0.0 |
|---|---|
| 抛出 |
|
参数
- 名称
string参数名称。
响应
空
onSetDocument
文档参数的设置器。
onSetDocument(\Joomla\CMS\Document\Document value) : \Joomla\CMS\Document\Document
onSetSubject
主题参数的设置器。
onSetSubject(\Joomla\Application\AbstractApplication value) : \Joomla\Application\AbstractApplication
| 自 |
5.0.0 |
|---|
参数
- 值
AbstractApplication要设置的值
响应
AbstractApplication
setArgument
向事件添加参数。
setArgument( name, value) :
如果存在，它将使用预处理方法。该方法具有以下签名
onSet<ArgumentName>($value): mixed
其中
$value 是用户正在设置的值 它返回要返回以设置在事件的 $arguments 数组中的值。
| 自 |
4.0.0 |
|---|
参数
- 名称
string参数名称。- 值
mixed值。
响应
$this
属性
eventNameToConcreteClass
将事件名称映射到具体事件类。
这仅适用于事件名称不变的事件。事件名称可变的事件在 getEventClassByEventName 类中使用 PHP 逻辑处理。
| 自 |
4.2.0 |
|---|
类型(s)
array<string|int, mixed>
已构造
一个标志，用于查看构造函数是否已被调用。
| 自 |
4.0.0 |
|---|
类型(s)
布尔