CMSApplicationInterface
扩展 ExtensionManagerInterface, ConfigurationAwareApplicationInterface, EventAwareInterface定义 Joomla! CMS 应用程序类的接口
| 自 |
4.0.0 |
|---|---|
| 注意 |
在 Joomla 6 中，此接口将不再扩展 EventAwareInterface |
| 只读属性 Input |
{@deprecated 将在 6.0 中删除} Joomla Input 属性。已弃用，支持使用 getInput() |
| 包 |
Joomla CMS |
方法
bootComponent
使用给定名称启动组件。
bootComponent( component) : \Joomla\CMS\Extension\ComponentInterface
bootModule
使用给定名称启动模块。
bootModule( module, applicationName) : \Joomla\CMS\Extension\ModuleInterface
bootPlugin
使用给定名称和类型启动插件。
bootPlugin( plugin, type) : \Joomla\CMS\Extension\PluginInterface
enqueueMessage
将系统消息入队。
enqueueMessage( msg, type = self::MSG_INFO) :
| 自 |
4.0.0 |
|---|
参数
- msg
string要入队的消息。- 类型
string消息类型。
响应
void
getDispatcher
获取事件调度器。
getDispatcher() : \Joomla\Event\DispatcherInterface
| 自 |
4.0.0 |
|---|---|
| 抛出 |
|
响应
DispatcherInterface
getIdentity
获取应用程序标识。
getIdentity() : \Joomla\CMS\User\User|null
getInput
获取应用程序输入对象的方法。
getInput() : \Joomla\Input\Input
| 自 |
4.0.0 |
|---|
响应
Input
getMessageQueue
获取系统消息队列。
getMessageQueue() : mixed||string|int
| 自 |
4.0.0 |
|---|
响应
array<string|int, mixed>系统消息队列。
getName
获取当前正在运行的应用程序的名称。
getName() :
| 自 |
4.0.0 |
|---|
响应
string应用程序的名称。
isCli
应用程序实例是 CLI 还是基于 Web 的应用程序的标志。
isCli() :
辅助函数，应使用本机 PHP 函数来检测它是否为 CLI 应用程序。
| 自 |
4.0.0 |
|---|---|
| 已弃用 |
4.0 将在 6.0 中删除 将无替换地删除。CLI 将由 joomla/console 包来处理 |
响应
bool
isClient
按名称检查客户端接口。
isClient( identifier) :
| 自 |
4.0.0 |
|---|
参数
- 标识符
string应用程序接口的字符串标识符
响应
bool如果此应用程序是给定类型的客户端接口，则为 True。
loadIdentity
允许应用程序加载自定义或默认标识。
loadIdentity(\Joomla\CMS\User\User identity = null) :
triggerEvent
调用与事件组关联的所有处理程序。
triggerEvent( eventName, array|\Joomla\Event\Event args = []) : mixed||string|int
这是一个遗留方法，实现了旧式（Joomla! 3.x）插件调用。最好直接通过调度器进行处理，并处理返回的 EventInterface 对象，而不是通过此方法。此方法已弃用，将在 Joomla! 5.x 中删除。
此方法将只返回事件的 'result' 参数
| 自 |
4.0.0 |
|---|---|
| 抛出 |
|
| 已弃用 |
4.0 将在 6.0 中删除 使用 Dispatcher 方法代替 示例：Factory::getApplication()->getDispatcher()->dispatch($eventName, $event); |
参数
- 事件名称
string事件名称。- 参数
array<string|int, mixed>|Event参数数组或事件对象（可选）。
响应
array<string|int, mixed>每个函数调用的结果数组。注意，如果没有设置调度器，则此数组将为空。
常量
MSG_EMERGENCY
定义入队紧急消息的常量
| 值 | 'emergency' |
|---|---|
| 自 |
4.0.0 |
类型
string
MSG_ALERT
定义入队警报消息的常量
| 值 | 'alert' |
|---|---|
| 自 |
4.0.0 |
类型
string
MSG_CRITICAL
定义入队严重消息的常量
| 值 | 'critical' |
|---|---|
| 自 |
4.0.0 |
类型
string
MSG_ERROR
定义入队错误消息的常量
| 值 | 'error' |
|---|---|
| 自 |
4.0.0 |
类型
string
MSG_WARNING
定义入队警告消息的常量
| 值 | 'warning' |
|---|---|
| 自 |
4.0.0 |
类型
string
MSG_NOTICE
定义入队通知消息的常量
| 值 | 'notice' |
|---|---|
| 自 |
4.0.0 |
类型
string
MSG_INFO
定义入队信息消息的常量
| 值 | 'info' |
|---|---|
| 自 |
4.0.0 |
类型
string
MSG_DEBUG
定义入队调试消息的常量
| 值 | 'debug' |
|---|---|
| 自 |
4.0.0 |
类型
string