CMSWebApplicationInterface
扩展自 SessionAwareWebApplicationInterface，CMSApplicationInterface定义用于 Web 应用程序的 Joomla! CMS 应用程序类的接口。
| 自 |
4.0.0 |
|---|---|
| 包 |
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要入队的消息。- type
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
getLanguage
获取应用程序语言对象的方法。
getLanguage() : \Joomla\CMS\Language\Language
getMenu
获取菜单对象。
getMenu( name = null, mixed||string|int options = []) : \Joomla\CMS\Menu\AbstractMenu|null
| 自 |
4.0.0 |
|---|
参数
- name
string菜单的应用程序名称- options
array<string|int, mixed>一个用于初始化菜单的选项数组
返回值
AbstractMenu|null一个 AbstractMenu 对象，如果未设置则为 null。
getMessageQueue
获取系统消息队列。
getMessageQueue() : mixed||string|int
| 自 |
4.0.0 |
|---|
返回值
array<string|int, mixed>系统消息队列。
getName
获取当前正在运行的应用程序的名称。
getName() :
| 自 |
4.0.0 |
|---|
返回值
string应用程序的名称。
getRouter
返回应用程序 Router 对象。
getRouter( name = null, mixed||string|int options = []) : \Joomla\CMS\Router\Router
| 自 |
4.0.0 |
|---|---|
| 已弃用 |
4.3 将在 6.0 中删除。注入路由器或从依赖项注入容器加载它。例如：Factory::getContainer()->get($name); |
参数
- name
string应用程序的名称。- options
array<string|int, mixed>一个可选的关联配置设置数组。
返回值
getUserState
获取用户状态。
getUserState( key, default = null) :
| 自 |
4.0.0 |
|---|
参数
- key
string状态的路径。- default
mixed可选的默认值，如果内部值为 null 则返回。
返回值
mixed用户状态或 null。
getUserStateFromRequest
获取用户状态变量的值。
getUserStateFromRequest( key, request, default = null, type = 'none') :
| 自 |
4.0.0 |
|---|
参数
- key
string用户状态变量的键。- request
string请求中传递的变量的名称。- default
string如果未找到变量的默认值。可选。- type
string变量的过滤器。可选。@see \Joomla\CMS\Filter\InputFilter::clean() 以获取有效值。
返回值
mixed请求用户状态。
isCli
应用程序实例是 CLI 还是基于 Web 的应用程序的标志。
isCli() :
帮助函数，您应该使用本机 PHP 函数来检测它是否是 CLI 应用程序。
| 自 |
4.0.0 |
|---|---|
| 已弃用 |
4.0 将在 6.0 中删除。将被删除且不提供替代方案。CLI 将由 joomla/console 包处理。 |
返回值
bool
isClient
按名称检查客户端接口。
isClient( identifier) :
| 自 |
4.0.0 |
|---|
参数
- identifier
string应用程序接口的字符串标识符
返回值
bool如果此应用程序属于给定类型的客户端接口，则为 True。
loadIdentity
允许应用程序加载自定义或默认标识。
loadIdentity(\Joomla\CMS\User\User identity = null) :
setUserState
设置用户状态变量的值。
setUserState( key, value) :
| 自 |
4.0.0 |
|---|
参数
- key
string状态的路径。- value
mixed变量的值。
返回值
mixed之前状态，如果存在。否则为 null。
triggerEvent
调用与事件组关联的所有处理程序。
triggerEvent( eventName, array|\Joomla\Event\Event args = []) : mixed||string|int
这是一个旧方法，实现了旧式（Joomla! 3.x）插件调用。最好直接通过调度器处理返回的 EventInterface 对象，而不是通过此方法。此方法已弃用，将在 Joomla! 5.x 中删除。
此方法将仅返回事件的“结果”参数
| 自 |
4.0.0 |
|---|---|
| 抛出 |
|
| 已弃用 |
4.0 将在 6.0 中删除。改用 Dispatcher 方法。例如：Factory::getApplication()->getDispatcher()->dispatch($eventName, $event); |
参数
- eventName
string事件名称。- args
array<string|int, mixed>|Event一个参数数组或一个 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