Joomla! API

下载
启动

CliApplication

扩展自 AbstractApplication 实现 CMSApplicationInterface

Joomla! 命令行应用程序的基础类。

抽象 已弃用
自

2.5.0
已弃用

4.0 将在 6.0 中移除 使用 ConsoleApplication 代替
包

Joomla CMS

方法

__construct

类构造函数。

__construct(\Joomla\Input\Input input = null, \Joomla\Registry\Registry config = null, \Joomla\CMS\Application\CLI\CliOutput output = null, \Joomla\CMS\Application\CLI\CliInput cliInput = null, \Joomla\Event\DispatcherInterface dispatcher = null, \Joomla\DI\Container container = null) :
自

1.7.0

参数

输入

Input|null一个可选参数，用于为应用程序的输入对象提供依赖注入。如果参数是 JInputCli 对象，则该对象将成为应用程序的输入对象，否则将创建一个默认的输入对象。

配置

Registry|null一个可选参数，用于为应用程序的配置对象提供依赖注入。如果参数是 Registry 对象，则该对象将成为应用程序的配置对象，否则将创建一个默认的配置对象。

输出

CliOutput|null输出处理程序。

cli输入

CliInput|nullCLI 输入处理程序。

调度器

DispatcherInterface|null一个可选参数，用于为应用程序的事件调度器提供依赖注入。如果参数是 DispatcherInterface 对象，则该对象将成为应用程序的事件调度器，如果为 null，则将根据应用程序的 loadDispatcher() 方法创建默认事件调度器。

容器

Container|null依赖注入容器。

响应

混合

__get

用于访问应用程序属性的魔术方法。

__get( name) :
已弃用
自

4.0.0
已弃用

4.0 将在 6.0 中移除 这是一个用于已弃用读取访问的 B/C 代理 示例：Factory::getApplication()->getInput();

参数

名称

字符串属性的名称。

响应

混合如果属性名称有效，则为一个值，否则为 null。

bootComponent

启动具有给定名称的组件。

bootComponent( component) : \Joomla\CMS\Extension\ComponentInterface
继承
自

4.0.0

参数

组件

字符串要启动的组件。

响应

ComponentInterface

bootModule

启动具有给定名称的模块。

bootModule( module,  applicationName) : \Joomla\CMS\Extension\ModuleInterface
继承
自

4.0.0

参数

模块

字符串要启动的模块

应用程序名称

字符串应用程序名称

响应

ModuleInterface

bootPlugin

启动具有给定名称和类型的插件。

bootPlugin( plugin,  type) : \Joomla\CMS\Extension\PluginInterface
继承
自

4.0.0

参数

插件

字符串插件名称

类型

字符串插件的类型

响应

PluginInterface

createExtensionNamespaceMap

允许应用程序加载自定义或默认标识。

createExtensionNamespaceMap() :
继承
自

4.0.0

响应

无效

enqueueMessage

将系统消息入队。

enqueueMessage( msg,  type = self::MSG_INFO) :
自

4.0.0

参数

消息

字符串要入队的消息。

类型

字符串消息类型。

响应

无效

execute

执行应用程序。

execute() :
自

1.7.0

响应

无效

getCliInput

获取 CLI 输入对象。

getCliInput() : \Joomla\CMS\Application\CLI\CliInput
自

4.0.0

响应

CliInput

getConfig

检索应用程序配置对象。

getConfig() : \Joomla\Registry\Registry
自

4.0.0

响应

注册表

getContainer

获取 DI 容器。

getContainer() : \Joomla\DI\Container
继承 抽象
自

4.0.0
抛出

ContainerNotFoundException如果未设置容器，则可能会抛出。

响应

容器

getDispatcher

获取事件调度器。

getDispatcher() : \Joomla\Event\DispatcherInterface
继承 抽象
自

4.0.0
抛出

UnexpectedValueException如果未设置调度器，则可能会抛出。

响应

DispatcherInterface

getIdentity

获取应用程序标识。

getIdentity() : \Joomla\CMS\User\User
继承
自

4.0.0

响应

用户

getInput

获取应用程序输入对象的方法。

getInput() : \Joomla\Input\Input
自

4.0.0

响应

输入

getInstance

返回对全局 CliApplication 对象的引用，仅在该对象尚不存在时才创建它。

getInstance( name = null) : \Joomla\CMS\Application\CliApplication
静态 已弃用

此方法必须按以下方式调用：$cli = CliApplication::getInstance();

自

1.7.0
已弃用

4.0 将在 6.0 中移除 通过容器或工厂加载应用程序 示例：Factory::getContainer()->get(CliApplication::class)
抛出

运行时异常

参数

名称

字符串要实例化的 Application Cli 类的名称（可选）。

响应

CliApplication

getLanguage

获取应用程序语言对象的方法。

getLanguage() : \Joomla\CMS\Language\Language
自

4.0.0

响应

Language语言对象

getLogger

获取日志记录器。

getLogger() : \Psr\Log\LoggerInterface
继承 抽象
自

4.0.0

响应

LoggerInterface

getMessageQueue

获取系统消息队列。

getMessageQueue() : mixed||string|int
自

4.0.0

响应

数组<字符串|整数, 混合>系统消息队列。

getOutput

获取输出对象。

getOutput() : \Joomla\CMS\Application\CLI\CliOutput
自

4.0.0

响应

CliOutput

getSession

获取应用程序会话对象的方法。

getSession() : \Joomla\Session\SessionInterface
自

4.0.0

响应

SessionInterface会话对象

in

从标准输入获取值。

in() :
自

4.0.0

响应

字符串来自标准输入的输入字符串。

isCli

应用程序实例是 CLI 还是基于 Web 的应用程序的标志。

isCli() :
已弃用

辅助函数，您应该使用本机 PHP 函数来检测它是否为 CLI 应用程序。

自

4.0.0
已弃用

4.0 将在 6.0 中移除 将在没有替换的情况下移除

响应

布尔

isClient

按名称检查客户端接口。

isClient( identifier) :
自

4.0.0

参数

标识符

字符串应用程序接口的字符串标识符

响应

布尔如果此应用程序属于给定类型的客户端接口，则为 True。

加载扩展

加载扩展。

loadExtension( type,  extensionName,  extensionPath) : \Joomla\CMS\Extension\ComponentInterface|\Joomla\CMS\Extension\ModuleInterface|\Joomla\CMS\Extension\PluginInterface
继承
自

4.0.0

参数

类型

字符串扩展类型

扩展名

字符串扩展名称

扩展路径

字符串扩展的路径

响应

ComponentInterface|ModuleInterface|PluginInterface

loadIdentity

允许应用程序加载自定义或默认标识。

loadIdentity(\Joomla\CMS\User\User identity = null) :
继承
自

4.0.0

参数

身份

User一个可选的身份对象。如果省略，则会创建一个 null 用户对象。

响应

$this

loadPluginFromFilesystem

从文件系统创建 CMS 插件。

loadPluginFromFilesystem( plugin,  type) : \Joomla\CMS\Plugin\CMSPlugin
继承
自

4.0.0

参数

插件

字符串插件

类型

字符串类型

响应

CMSPlugin

out

将字符串写入标准输出。

out( text = '',  nl = true) :
自

4.0.0

参数

文本

字符串要显示的文本。

nl

布尔True（默认）在输出字符串末尾追加一个新行。

响应

$this

registerEvent

向特定事件组注册处理程序。

registerEvent( event, 
Warning: Array to string conversion in /opt/phpdoc/vendor/twig/twig/src/Extension/CoreExtension.php on line 768
|Array handler) :
继承
自

4.0.0

参数

事件

字符串事件名称。

处理程序

可调用处理程序，一个函数或事件对象的实例。

响应

$this

setOutput

设置输出对象。

setOutput(\Joomla\CMS\Application\CLI\CliOutput output) :
自

3.3

参数

输出

CliOutputCliOutput 对象

响应

$this

triggerEvent

调用与事件组关联的所有处理程序。

triggerEvent( eventName, array|\Joomla\Event\Event args = []) : mixed||string|int
继承 已弃用

这是一个遗留方法，实现了旧样式（Joomla! 3.x）插件调用。最好直接通过 Dispatcher 处理返回的 EventInterface 对象，而不是通过此方法。此方法已弃用，将在 Joomla! 5.x 中移除。

此方法将仅返回事件的“结果”参数

自

4.0.0
抛出

InvalidArgumentException
已弃用

4.0 将在 6.0 中移除 使用 Dispatcher 方法代替 示例：Factory::getApplication()->getDispatcher()->dispatch($eventName, $event);

参数

事件名称

字符串事件名称。

参数

数组<字符串|整数, 混合>|Event参数数组或 Event 对象（可选）。

响应

数组<字符串|整数, 混合>每个函数调用的结果数组。请注意，如果未设置调度器，则此数组将为空。

属性

身份

应用程序标识对象。

继承
自

4.0.0

类型(s)

用户

输出

输出对象

自

4.0.0

类型(s)

CliOutput

输入

输入。

自

4.0.0

类型(s)

输入

cli输入

CLI 输入对象

自

4.0.0

类型(s)

CliInput

语言

应用程序语言对象。

自

4.0.0

类型(s)

语言

消息

应用程序消息队列。

自

4.0.0

类型(s)

数组<字符串|整数, 混合>

实例

应用程序实例。

静态
自

1.7.0

类型(s)

CliApplication
  • \ Joomla
  • \ CMS
  • \ 应用程序
  • \ CliApplication