Joomla! API

下载
启动

Application

扩展 AbstractApplication

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

自

2.0.0
包

Joomla 框架

方法

__construct

类构造函数。

__construct(\Symfony\Component\Console\Input\InputInterface input = null, \Symfony\Component\Console\Output\OutputInterface output = null, \Joomla\Registry\Registry config = null) :
自

2.0.0

参数

input

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

output

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

config

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

响应

混合

addCommand

添加命令对象。

addCommand(\Joomla\Console\Command\AbstractCommand command) : \Joomla\Console\Command\AbstractCommand

如果已存在具有相同名称的命令，则将被覆盖。如果命令未启用，则不会添加。

自

2.0.0
抛出

LogicException

参数

command

AbstractCommand要添加到应用程序的命令。

响应

AbstractCommand

close

关闭应用程序的方法。

close( code) :
继承
自

1.0.0

参数

code

int退出代码（可选；默认值为 0）。

响应

void

configureIO

为进程配置控制台输入和输出实例。

configureIO() :
自

2.0.0

响应

void

dispatchEvent

如果已设置调度程序，则调度应用程序事件。

dispatchEvent( eventName, \Joomla\Event\EventInterface|null event = null) : \Joomla\Event\EventInterface|null
继承
自

2.0.0

参数

eventName

string要调度的事件。

event

EventInterface|null事件对象。

响应

EventInterface|null已调度的事件，如果未设置调度程序，则为 null

doExecute

运行应用程序例程的方法。

doExecute() :
自

2.0.0
抛出

Throwable

响应

int应用程序的退出代码

doRenderThrowable

处理递归地为 Throwable 及其包含的所有先前 Throwables 渲染错误消息。

doRenderThrowable(\Throwable throwable, \Symfony\Component\Console\Output\OutputInterface output) :
自

2.0.0

参数

throwable

Throwable要为其渲染消息的 Throwable 对象。

output

OutputInterface要发送消息的输出对象。

响应

void

execute

执行应用程序。

execute() :
自

2.0.0
抛出

Throwable

响应

void

extractAllNamespaces

返回命令名称的所有命名空间。

extractAllNamespaces( name) : string||string|int
自

2.0.0

参数

name

string命令的完整名称

响应

array<string|int, string>

extractNamespace

返回命令名称的命名空间部分。

extractNamespace( name, int limit = null) :
自

2.0.0

参数

name

string要处理的命令名称

limit

int|null命名空间部分的最大数量

响应

string

findNamespace

通过名称查找注册的命名空间。

findNamespace( namespace) :
自

2.0.0
抛出

NamespaceNotFoundException当命名空间不正确或不明确时

参数

namespace

string要搜索的命名空间

响应

string

get

返回对象的属性或属性未设置时的默认值。

get( key,  default = null) :
继承
自

1.0.0

参数

key

string属性的名称。

default

mixed默认值（可选），如果未设置。

响应

mixed配置的值。

getAllCommands

获取所有命令，包括通过命令加载程序提供的命令，也可以根据命令命名空间进行过滤。

getAllCommands( namespace = '') : \Joomla\Console\Command\AbstractCommand||string|int
自

2.0.0

参数

namespace

string一个可选的命令命名空间，用于过滤。

响应

array<string|int, AbstractCommand>

getCommand

通过名称或别名返回注册的命令。

getCommand( name) : \Joomla\Console\Command\AbstractCommand
自

2.0.0
抛出

CommandNotFoundException

参数

name

string命令名称或别名

响应

AbstractCommand

getCommandName

获取要运行的命令的名称。

getCommandName(\Symfony\Component\Console\Input\InputInterface input) : string|null
自

2.0.0

参数

input

InputInterface要从中读取参数的输入

响应

string|null

getCommands

获取已注册的命令。

getCommands() : \Joomla\Console\Command\AbstractCommand||string|int

此方法仅检索已显式注册的命令。要获取所有命令（包括来自命令加载程序的命令），请使用 getAllCommands() 方法。

自

2.0.0

响应

array<string|int, AbstractCommand>

getConsoleInput

获取控制台输入处理程序。

getConsoleInput() : \Symfony\Component\Console\Input\InputInterface
自

2.0.0

响应

InputInterface

getConsoleOutput

获取控制台输出处理程序。

getConsoleOutput() : \Symfony\Component\Console\Output\OutputInterface
自

2.0.0

响应

OutputInterface

getDefaultCommands

获取应默认注册到应用程序的命令。

getDefaultCommands() : \Joomla\Console\Command\AbstractCommand||string|int
自

2.0.0

响应

array<string|int, AbstractCommand>

getDefaultHelperSet

构建默认辅助程序集。

getDefaultHelperSet() : \Symfony\Component\Console\Helper\HelperSet
自

2.0.0

响应

HelperSet

getDefaultInputDefinition

构建默认输入定义。

getDefaultInputDefinition() : \Symfony\Component\Console\Input\InputDefinition
自

2.0.0

响应

InputDefinition

getDefinition

获取与该应用程序相关的 InputDefinition。

getDefinition() : \Symfony\Component\Console\Input\InputDefinition
自

2.0.0

响应

InputDefinition

getDispatcher

获取事件调度程序。

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

1.2.0
抛出

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

响应

DispatcherInterface

getHelperSet

获取与应用程序关联的辅助程序集。

getHelperSet() : \Symfony\Component\Console\Helper\HelperSet

响应

HelperSet

getLogger

获取日志记录器。

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

1.0.0

响应

LoggerInterface

getLongVersion

获取应用程序的完整版本字符串。

getLongVersion() :

通常，这是应用程序名称和版本，用于应用程序帮助输出。

自

2.0.0

响应

string

getName

获取应用程序的名称。

getName() :
自

2.0.0

响应

string

getNamespaces

返回当前注册命令使用的所有唯一命名空间的数组。

getNamespaces() : string||string|int

请注意，这并不包括始终存在的全局命名空间。

自

2.0.0

响应

array<string|int, string>

getVersion

获取应用程序的版本。

getVersion() :
自

2.0.0

响应

string

hasCommand

检查应用程序是否具有给定名称的命令。

hasCommand( name) :
自

2.0.0

参数

name

string要检查是否存在命令的名称。

响应

bool

initCommands

初始化命令存储的内部函数，这允许仅在需要时才延迟加载存储。

initCommands() :
自

2.0.0

响应

void

initialise

自定义初始化方法。

initialise() :
自

2.0.0

响应

void

renderThrowable

为 Throwable 对象渲染错误消息

renderThrowable(\Throwable throwable) :
自

2.0.0

参数

throwable

Throwable要为其渲染消息的 Throwable 对象。

响应

void

runCommand

运行给定的命令。

runCommand(\Joomla\Console\Command\AbstractCommand command, \Symfony\Component\Console\Input\InputInterface input, \Symfony\Component\Console\Output\OutputInterface output) :
自

2.0.0
抛出

Throwable

参数

command

AbstractCommand要运行的命令。

input

InputInterface要注入到命令中的输入。

output

OutputInterface要注入到命令中的输出。

响应

int

set

修改对象的属性，如果它不存在则创建它。

set( key,  value = null) :
继承
自

1.0.0

参数

key

string属性的名称。

value

mixed要设置的属性的值（可选）。

响应

mixed属性的先前值

setAutoExit

设置应用程序是否应在命令运行后自动退出。

setAutoExit( autoExit) :
自

2.0.0

参数

autoExit

bool自动退出状态。

响应

void

setCatchThrowables

设置应用程序是否应捕获 Throwables。

setCatchThrowables( catchThrowables) :
自

2.0.0

参数

catchThrowables

bool捕获 Throwables 状态。

响应

void

setCommandLoader

设置命令加载程序。

setCommandLoader(\Joomla\Console\Loader\LoaderInterface loader) :
自

2.0.0

参数

loader

LoaderInterface新的命令加载程序。

响应

void

setConfiguration

设置应用程序的配置。

setConfiguration(\Joomla\Registry\Registry config) :
继承
自

1.0.0

参数

config

Registry保存配置的注册表对象。

响应

$this

setDispatcher

设置要使用的调度程序。

setDispatcher(\Joomla\Event\DispatcherInterface dispatcher) :
继承
自

1.2.0

参数

dispatcher

DispatcherInterface要使用的调度程序。

响应

$this

setHelperSet

设置应用程序的辅助程序集。

setHelperSet(\Symfony\Component\Console\Helper\HelperSet helperSet) :
自

2.0.0

参数

helperSet

HelperSet新的 HelperSet。

响应

void

setName

设置应用程序的名称。

setName( name) :
自

2.0.0

参数

name

string新的应用程序名称。

响应

void

setVersion

设置应用程序的版本。

setVersion( version) :
自

2.0.0

参数

version

string新的应用程序版本。

响应

void

shouldAutoExit

获取应用程序的自动退出状态。

shouldAutoExit() :
自

2.0.0

响应

bool

shouldCatchThrowables

获取应用程序的捕获 Throwables 状态。

shouldCatchThrowables() :
自

2.0.0

响应

bool

splitStringByWidth

为指定宽度拆分字符串，以便在输出中使用。

splitStringByWidth( string,  width) : string||string|int
自

2.0.0

参数

string

string要拆分的字符串。

width

int输出的最大宽度。

响应

array<string|int, string>

属性

dispatcher

事件调度程序

继承
自

1.2.0

类型

DispatcherInterface|null

config

应用程序配置对象。

继承
自

1.0.0

类型

Registry

autoExit

指示应用程序应在命令运行后自动退出的标志。

自

2.0.0

类型

bool

catchThrowables

指示应用程序应捕获和处理 Throwables 的标志。

自

2.0.0

类型

bool

commands

可用的命令。

自

2.0.0

类型

array<string|int, AbstractCommand>

commandLoader

命令加载程序。

自

2.0.0

类型

LoaderInterface|null

consoleInput

控制台输入处理程序。

自

2.0.0

类型

InputInterface

consoleOutput

控制台输出处理程序。

自

2.0.0

类型

OutputInterface

defaultCommand

应用程序的默认命令。

自

2.0.0

类型

string

definition

应用程序输入定义。

自

2.0.0

类型

InputDefinition|null

helperSet

应用程序辅助程序集。

自

2.0.0

类型

HelperSet|null

已初始化

内部标志，用于跟踪命令存储区是否已初始化。

自

2.0.0

类型

bool

name

应用程序的名称。

自

2.0.0

类型

string

正在运行的命令

对当前正在运行的命令的引用。

自

2.0.0

类型

AbstractCommand|null

终端

控制台终端助手。

自

2.0.0

类型

终端

version

应用程序的版本。

自

2.0.0

类型

string

需要帮助

内部标志，用于跟踪用户是否正在寻求给定命令的帮助。

自

2.0.0

类型

bool
  • \ Joomla
  • \ 控制台
  • \ 应用程序