Properties

$requiredCount

$requiredCount : 

Type

$hasAnArrayArgument

$hasAnArrayArgument : 

Type

$hasOptional

$hasOptional : 

Type

$shortcuts

$shortcuts : 

Type

Methods

__construct()

__construct(array  $definition = array()) 

构造方法

Parameters

array $definition

setDefinition()

setDefinition(array  $definition) 

设置指令的定义

Parameters

array $definition

定义的数组

setArguments()

setArguments(array<mixed,\think\console\input\Argument>  $arguments = array()) 

设置参数

Parameters

array<mixed,\think\console\input\Argument> $arguments

参数数组

addArguments()

addArguments(array<mixed,\think\console\input\Argument>  $arguments = array()) 

添加参数

Parameters

array<mixed,\think\console\input\Argument> $arguments

参数数组

addArgument()

addArgument(\think\console\input\Argument  $argument) 

添加一个参数

Parameters

\think\console\input\Argument $argument

参数

Throws

\LogicException

getArgument()

getArgument(string|integer  $name) : \think\console\input\Argument

根据名称或者位置获取参数

Parameters

string|integer $name

参数名或者位置

Throws

\InvalidArgumentException

Returns

\think\console\input\Argument

参数

hasArgument()

hasArgument(string|integer  $name) : boolean

根据名称或位置检查是否具有某个参数

Parameters

string|integer $name

参数名或者位置

Returns

boolean

getArguments()

getArguments() : array<mixed,\think\console\input\Argument>

获取所有的参数

Returns

array<mixed,\think\console\input\Argument> —

参数数组

getArgumentCount()

getArgumentCount() : integer

获取参数数量

Returns

integer

getArgumentRequiredCount()

getArgumentRequiredCount() : integer

获取必填的参数的数量

Returns

integer

getArgumentDefaults()

getArgumentDefaults() : array

获取参数默认值

Returns

array

setOptions()

setOptions(array<mixed,\think\console\input\Option>  $options = array()) 

设置选项

Parameters

array<mixed,\think\console\input\Option> $options

选项数组

addOptions()

addOptions(array<mixed,\think\console\input\Option>  $options = array()) 

添加选项

Parameters

array<mixed,\think\console\input\Option> $options

选项数组

addOption()

addOption(\think\console\input\Option  $option) 

添加一个选项

Parameters

\think\console\input\Option $option

选项

Throws

\LogicException

getOption()

getOption(string  $name) : \think\console\input\Option

根据名称获取选项

Parameters

string $name

选项名

Throws

\InvalidArgumentException

Returns

\think\console\input\Option

hasOption()

hasOption(string  $name) : boolean

根据名称检查是否有这个选项

Parameters

string $name

选项名

Returns

boolean

getOptions()

getOptions() : array<mixed,\think\console\input\Option>

获取所有选项

Returns

array<mixed,\think\console\input\Option>

hasShortcut()

hasShortcut(string  $name) : boolean

根据名称检查某个选项是否有短名称

Parameters

string $name

短名称

Returns

boolean

getOptionForShortcut()

getOptionForShortcut(string  $shortcut) : \think\console\input\Option

根据短名称获取选项

Parameters

string $shortcut

短名称

Returns

\think\console\input\Option

getOptionDefaults()

getOptionDefaults() : array

获取所有选项的默认值

Returns

array

getSynopsis()

getSynopsis(boolean  $short = false) : string

获取该指令的介绍

Parameters

boolean $short

是否简洁介绍

Returns

string

shortcutToName()

shortcutToName(string  $shortcut) : string

根据短名称获取选项名

Parameters

string $shortcut

短名称

Throws

\InvalidArgumentException

Returns

string