Joomla! API

下载
启动

EditEntryCommand

扩展自 AbstractKeychainCommand

用于编辑密钥链中条目的命令类

自版本

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

参数

名称

字符串参数名称

模式

整数|空参数模式：InputArgument::REQUIRED 或 InputArgument::OPTIONAL

描述

字符串描述文本

默认值

混合类型默认值（仅限 InputArgument::OPTIONAL 模式）

返回值

$this

addOption

向输入定义添加选项。

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

2.0.0

参数

名称

字符串选项名称

快捷键

字符串|数组<字符串|整数, 混合类型>快捷键，可以为 null、由 | 分隔的快捷键字符串或快捷键数组

模式

整数|空选项模式：VALUE_* 常量之一

描述

字符串描述文本

默认值

混合类型|空默认值（对于 InputOption::VALUE_NONE 必须为 null）

返回值

$this

configure

配置命令。

configure() :
自版本

2.0.0

返回值

空

doExecute

执行命令的内部函数。

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

2.0.0

参数

输入

InputInterface注入命令的输入。

输出

OutputInterface注入命令的输出。

返回值

整数命令退出代码

execute

执行命令。

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

2.0.0

参数

输入

InputInterface注入命令的输入。

输出

OutputInterface注入命令的输出。

返回值

整数命令退出代码

getAliases

获取命令的别名。

getAliases() : string||string|int
继承的
自版本

2.0.0

返回值

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

getApplication

获取应用程序对象。

getApplication() : \Joomla\Console\Application
继承的
自版本

2.0.0
抛出

UnexpectedValueException如果未设置应用程序。

返回值

Application应用程序对象。

getDefaultName

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

getDefaultName() : string|null
继承的 静态

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

自版本

2.0.0

返回值

字符串|空

getDefinition

获取附加到此命令的 InputDefinition。

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

2.0.0

返回值

InputDefinition

getDescription

获取命令的描述。

getDescription() :
继承的
自版本

2.0.0

返回值

字符串

getHelp

获取命令的帮助信息。

getHelp() :
继承的
自版本

2.0.0

返回值

字符串

getHelperSet

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

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

2.0.0

返回值

HelperSet|空

getName

获取命令的名称。

getName() : string|null
继承的
自版本

2.0.0

返回值

字符串|空

getProcessedHelp

返回命令的已处理帮助信息。

getProcessedHelp() :
继承的

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

自版本

2.0.0

返回值

字符串

getSynopsis

获取命令的摘要。

getSynopsis( short = false) :
继承的
自版本

2.0.0

参数

简短

布尔值指示应返回摘要的简短版本还是完整版本的标志

返回值

字符串

initialise

在绑定输入后和验证输入之前初始化命令的内部钩子。

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

2.0.0

参数

输入

InputInterface注入命令的输入。

输出

OutputInterface注入命令的输出。

返回值

空

initialiseKeychain

初始化密钥链。

initialiseKeychain(\Symfony\Component\Console\Input\InputInterface input) :
继承的
自版本

2.0.0
抛出

InvalidArgumentException

参数

输入

InputInterface注入命令的输入。

返回值

空

isEnabled

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

isEnabled() :
继承的
自版本

2.0.0

返回值

布尔值

isHidden

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

isHidden() :
继承的
自版本

2.0.0

返回值

布尔值

saveKeychain

保存密钥链。

saveKeychain() :
继承的
自版本

2.0.0
抛出

RuntimeException

返回值

布尔值

setAliases

设置命令的别名。

setAliases(string||string|int aliases) :
继承的
自版本

2.0.0

参数

别名

数组<字符串|整数, 字符串>命令别名

返回值

空

setApplication

设置命令的应用程序。

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

2.0.0

参数

应用程序

Application|空命令的应用程序

返回值

空

setDefinition

设置命令的输入定义。

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

2.0.0

参数

定义

数组<字符串|整数, 混合类型>|InputDefinitionInputDefinition 对象或要写入定义的对象数组。

返回值

空

setDescription

设置命令的描述。

setDescription( description) :
继承的
自版本

2.0.0

参数

描述

字符串命令的描述

返回值

空

setHelp

设置命令的帮助信息。

setHelp( help) :
继承的
自版本

2.0.0

参数

帮助

字符串命令的帮助信息

返回值

空

setHelperSet

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

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

2.0.0

参数

helperSet

HelperSet帮助程序集。

返回值

空

setHidden

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

setHidden( hidden) :
继承的
自版本

2.0.0

参数

隐藏

布尔值此命令是否隐藏的标志。

返回值

空

setName

设置命令的名称。

setName( name) :
继承的
自版本

2.0.0

参数

名称

字符串命令名称

返回值

空

属性

defaultName

默认命令名称

静态
自版本

2.0.0

类型(s)

字符串|空

别名

命令的别名。

继承的
自版本

2.0.0

类型(s)

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

应用程序

运行此命令的应用程序。

继承的
自版本

2.0.0

类型(s)

Application|空

applicationDefinitionMerged

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

继承的
自版本

2.0.0

类型(s)

布尔值

applicationDefinitionMergedWithArgs

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

继承的
自版本

2.0.0

类型(s)

布尔值

定义

命令的输入定义。

继承的
自版本

2.0.0

类型(s)

InputDefinition

描述

命令的描述。

继承的
自版本

2.0.0

类型(s)

字符串

帮助

命令的帮助信息。

继承的
自版本

2.0.0

类型(s)

字符串

helperSet

命令的输入帮助程序集。

继承的
自版本

2.0.0

类型(s)

HelperSet|空

隐藏

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

继承的
自版本

2.0.0

类型(s)

布尔值

名称

命令的名称。

继承的
自版本

2.0.0

类型(s)

字符串

synopsis

命令的摘要。

继承的
自版本

2.0.0

类型(s)

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

crypt

加密处理程序。

继承的
自版本

2.0.0

类型(s)

Crypt

filename

密钥链文件的路径。

继承的
自版本

2.0.0

类型(s)

字符串

keychain

正在管理的密钥链。

继承的
自版本

2.0.0

类型(s)

Keychain
  • \ Joomla
  • \ Keychain
  • \ Command
  • \ EditEntryCommand