Joomla! API

下载
启动

AbstractKeychainCommand

扩展 AbstractCommand

所有密钥链控制台命令的基类。

抽象的
自

2.0.0
包

Joomla 框架

方法

__construct

构造函数

__construct(\Joomla\Crypt\Crypt crypt) :
自

2.0.0

参数

crypt

Crypt密钥链中使用的加密处理程序。

响应

混合

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命令退出代码

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
继承的 静态的

这允许在不实例化完整命令类的情况下定义和引用命令名称。

自

2.0.0

响应

string|null

getDefinition

获取附加到此命令的 InputDefinition。

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

2.0.0

响应

InputDefinition

getDescription

获取命令的描述。

getDescription() :
继承的
自

2.0.0

响应

string

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

initialiseKeychain

初始化密钥链。

initialiseKeychain(\Symfony\Component\Console\Input\InputInterface input) :
自

2.0.0
抛出

InvalidArgumentException

参数

input

InputInterface要注入命令的输入。

响应

void

isEnabled

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

isEnabled() :
继承的
自

2.0.0

响应

bool

isHidden

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

isHidden() :
继承的
自

2.0.0

响应

bool

saveKeychain

保存密钥链。

saveKeychain() :
自

2.0.0
抛出

RuntimeException

响应

bool

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

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

默认命令名称

继承的 静态的
自

2.0.0

类型(s)

string|null

aliases

命令的别名。

继承的
自

2.0.0

类型(s)

array<string|int, string>

application

运行此命令的应用程序。

继承的
自

2.0.0

类型(s)

Application|null

applicationDefinitionMerged

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

继承的
自

2.0.0

类型(s)

bool

applicationDefinitionMergedWithArgs

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

继承的
自

2.0.0

类型(s)

bool

definition

命令的输入定义。

继承的
自

2.0.0

类型(s)

InputDefinition

description

命令的描述。

继承的
自

2.0.0

类型(s)

string

help

命令的帮助。

继承的
自

2.0.0

类型(s)

string

helperSet

命令的输入帮助程序集。

继承的
自

2.0.0

类型(s)

HelperSet|null

hidden

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

继承的
自

2.0.0

类型(s)

bool

name

命令的名称。

继承的
自

2.0.0

类型(s)

string

synopsis

命令的概要。

继承的
自

2.0.0

类型(s)

array<string|int, string>

crypt

加密处理程序。

自

2.0.0

类型(s)

Crypt

filename

密钥链文件的路径。

自

2.0.0

类型(s)

string

keychain

正在管理的密钥链。

自

2.0.0

类型(s)

Keychain
  • \ Joomla
  • \ Keychain
  • \ Command
  • \ AbstractKeychainCommand