Joomla! API

下载
启动

DebugEventDispatcherCommand

扩展 AbstractCommand 实现 DispatcherAwareInterface

关于应用程序事件调度器的命令列表信息。

自

2.0.0
包

Joomla 框架

方法

__construct

实例化命令。

__construct(\Joomla\Event\DispatcherInterface dispatcher) :
自

2.0.0

参数

dispatcher

DispatcherInterface应用程序事件调度器。

响应

混合

addArgument

向输入定义添加参数。

addArgument( name, int mode = null,  description = '',  default = null) :
继承
自

2.0.0

参数

name

string参数名称

mode

int|null参数模式：InputArgument::REQUIRED 或 InputArgument::OPTIONAL

description

string描述文本

default

mixed默认值（仅针对 InputArgument::OPTIONAL 模式）

响应

$this

addOption

向输入定义添加选项。

addOption( name, string|array shortcut = null, int mode = null,  description = '', mixed default = null) :
继承
自

2.0.0

参数

name

string选项名称

shortcut

string|array<string|int, mixed>快捷方式，可以为 null、由 | 分隔的快捷方式字符串或快捷方式数组

mode

int|null选项模式：VALUE_* 常量之一

description

string描述文本

default

mixed|null默认值（对于 InputOption::VALUE_NONE 必须为 null）

响应

$this

configure

配置命令。

configure() :
自

2.0.0

响应

void

doExecute

内部函数，用于执行命令。

doExecute(\Symfony\Component\Console\Input\InputInterface input, \Symfony\Component\Console\Output\OutputInterface output) :
自

2.0.0

参数

input

InputInterface要注入命令的输入。

output

OutputInterface要注入命令的输出。

响应

int命令退出代码

execute

执行命令。

execute(\Symfony\Component\Console\Input\InputInterface input, \Symfony\Component\Console\Output\OutputInterface output) :
继承
自

2.0.0

参数

input

InputInterface要注入命令的输入。

output

OutputInterface要注入命令的输出。

响应

int命令退出代码

formatCallable

格式化要在控制台输出中显示的可调用资源

formatCallable(
Warning: Array to string conversion in /opt/phpdoc/vendor/twig/twig/src/Extension/CoreExtension.php on line 768
|Array callable) :
自

2.0.0
抛出

ReflectionException
注意

此方法基于 \Symfony\Bundle\FrameworkBundle\Console\Descriptor\TextDescriptor::formatCallable()

参数

callable

callable要格式化的可调用资源

响应

string

getAliases

获取命令的别名。

getAliases() : string||string|int
继承
自

2.0.0

响应

array<string|int, string>

getApplication

获取应用程序对象。

getApplication() : \Joomla\Console\Application
继承
自

2.0.0
抛出

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

响应

Application应用程序对象。

getDefaultName

获取此类的默认命令名称。

getDefaultName() : string|null
inherited static

这允许定义和引用命令名称，而无需实例化完整的命令类。

自

2.0.0

响应

string|null

getDefinition

获取附加到此命令的 InputDefinition。

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

2.0.0

响应

InputDefinition

getDescription

获取命令的描述。

getDescription() :
继承
自

2.0.0

响应

string

getDispatcher

获取事件调度器。

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

1.2.0
抛出

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

响应

DispatcherInterface

getHelp

获取命令的帮助。

getHelp() :
继承
自

2.0.0

响应

string

getHelperSet

获取命令的输入帮助程序集。

getHelperSet() : \Symfony\Component\Console\Helper\HelperSet|null
继承
自

2.0.0

响应

HelperSet|null

getName

获取命令的名称。

getName() : string|null
继承
自

2.0.0

响应

string|null

getProcessedHelp

返回命令的已处理帮助。

getProcessedHelp() :
继承

此方法用于用真实值替换命令中的占位符。默认情况下，这支持 %command.name% 和 %command.full_name。

自

2.0.0

响应

string

getSynopsis

获取命令的概要。

getSynopsis( short = false) :
继承
自

2.0.0

参数

short

bool指示应返回概要的简短版本还是长版本的标志

响应

string

initialise

内部钩子，用于在绑定输入后且验证输入之前初始化命令。

initialise(\Symfony\Component\Console\Input\InputInterface input, \Symfony\Component\Console\Output\OutputInterface output) :
继承
自

2.0.0

参数

input

InputInterface要注入命令的输入。

output

OutputInterface要注入命令的输出。

响应

void

isEnabled

检查命令在此环境中是否已启用。

isEnabled() :
继承
自

2.0.0

响应

bool

isHidden

检查命令是否从命令列表中隐藏。

isHidden() :
继承
自

2.0.0

响应

bool

renderEventListenerTable

渲染事件监听器表

renderEventListenerTable(mixed||string|int eventListeners, \Symfony\Component\Console\Style\SymfonyStyle io) :
自

2.0.0

参数

eventListeners

array<string|int, mixed>事件的监听器

io

SymfonyStyleI/O 帮助程序

响应

void

setAliases

设置命令的别名。

setAliases(string||string|int aliases) :
继承
自

2.0.0

参数

aliases

array<string|int, string>命令别名

响应

void

setApplication

设置命令的应用程序。

setApplication(\Joomla\Console\Application application = null) :
继承
自

2.0.0

参数

application

Application|null命令的应用程序

响应

void

setDefinition

设置命令的输入定义。

setDefinition(array|\Symfony\Component\Console\Input\InputDefinition definition) :
继承
自

2.0.0

参数

definition

array<string|int, mixed>|InputDefinitionInputDefinition 对象或要写入定义的对象数组。

响应

void

setDescription

设置命令的描述。

setDescription( description) :
继承
自

2.0.0

参数

description

string命令的描述

响应

void

setDispatcher

设置要使用的调度器。

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

1.2.0

参数

dispatcher

DispatcherInterface要使用的调度器。

响应

$this

setHelp

设置命令的帮助。

setHelp( help) :
继承
自

2.0.0

参数

help

string命令的帮助

响应

void

setHelperSet

设置命令的输入帮助程序集。

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

2.0.0

参数

helperSet

HelperSet帮助程序集。

响应

void

setHidden

设置此命令是否从命令列表中隐藏。

setHidden( hidden) :
继承
自

2.0.0

参数

hidden

bool此命令是否隐藏的标志。

响应

void

setName

设置命令的名称。

setName( name) :
继承
自

2.0.0

参数

name

string命令名称

响应

void

属性

defaultName

默认命令名称

static
自

2.0.0

类型

string

aliases

命令的别名。

继承
自

2.0.0

类型

array<string|int, string>

application

运行此命令的应用程序。

继承
自

2.0.0

类型

Application|null

applicationDefinitionMerged

跟踪应用程序定义是否已合并到此命令的标志。

继承
自

2.0.0

类型

bool

applicationDefinitionMergedWithArgs

跟踪带参数的应用程序定义是否已合并到此命令的标志。

继承
自

2.0.0

类型

bool

definition

命令的输入定义。

继承
自

2.0.0

类型

InputDefinition

description

命令的描述。

继承
自

2.0.0

类型

string

help

命令的帮助。

继承
自

2.0.0

类型

string

helperSet

命令的输入帮助程序集。

继承
自

2.0.0

类型

HelperSet|null

hidden

跟踪命令是否从命令列表中隐藏的标志。

继承
自

2.0.0

类型

bool

name

命令的名称。

继承
自

2.0.0

类型

string

synopsis

命令的概要。

继承
自

2.0.0

类型

array<string|int, string>

dispatcher

事件调度器

继承
自

1.2.0

类型

DispatcherInterface|null
  • \ Joomla
  • \ Event
  • \ Command
  • \ DebugEventDispatcherCommand