Properties

$arguments

$arguments : \think\console\input\Argument[]

Type

Argument[]

$requiredCount

$requiredCount

$hasAnArrayArgument

$hasAnArrayArgument

$hasOptional

$hasOptional

$options

$options : \think\console\input\Option[]

Type

Option[]

$shortcuts

$shortcuts

Methods

__construct()

__construct(array  $definition = []) : mixed

构造方法

Parameters

array $definition

Returns

mixed —

setDefinition()

setDefinition(array  $definition) : mixed

设置指令的定义

Parameters

array $definition

定义的数组

Returns

mixed —

setArguments()

setArguments(\think\console\input\Argument[]  $arguments = []) : mixed

设置参数

Parameters

\think\console\input\Argument[] $arguments

参数数组

Returns

mixed —

addArguments()

addArguments(\think\console\input\Argument[]  $arguments = []) : mixed

添加参数

Parameters

\think\console\input\Argument[] $arguments

参数数组

Returns

mixed —

addArgument()

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

添加一个参数

Parameters

\think\console\input\Argument $argument

参数

Throws

\LogicException

Returns

mixed —

getArgument()

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

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

Parameters

string|int $name

参数名或者位置

Throws

\InvalidArgumentException

Returns

\think\console\input\Argument —

参数

hasArgument()

hasArgument(string|int  $name) : bool

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

Parameters

string|int $name

参数名或者位置

Returns

bool —

getArguments()

getArguments() : \think\console\input\Argument[]

获取所有的参数

Returns

\think\console\input\Argument[] —

参数数组

getArgumentCount()

getArgumentCount() : int

获取参数数量

Returns

int —

getArgumentRequiredCount()

getArgumentRequiredCount() : int

获取必填的参数的数量

Returns

int —

getArgumentDefaults()

getArgumentDefaults() : array

获取参数默认值

Returns

array —

setOptions()

setOptions(\think\console\input\Option[]  $options = []) : mixed

设置选项

Parameters

\think\console\input\Option[] $options

选项数组

Returns

mixed —

addOptions()

addOptions(\think\console\input\Option[]  $options = []) : mixed

添加选项

Parameters

\think\console\input\Option[] $options

选项数组

Returns

mixed —

addOption()

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

添加一个选项

Parameters

\think\console\input\Option $option

选项

Throws

\LogicException

Returns

mixed —

getOption()

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

根据名称获取选项

Parameters

string $name

选项名

Throws

\InvalidArgumentException

Returns

\think\console\input\Option —

hasOption()

hasOption(string  $name) : bool

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

Parameters

string $name

选项名

Returns

bool —

getOptions()

getOptions() : \think\console\input\Option[]

获取所有选项

Returns

\think\console\input\Option[] —

hasShortcut()

hasShortcut(string  $name) : bool

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

Parameters

string $name

短名称

Returns

bool —

getOptionForShortcut()

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

根据短名称获取选项

Parameters

string $shortcut

短名称

Returns

\think\console\input\Option —

getOptionDefaults()

getOptionDefaults() : array

获取所有选项的默认值

Returns

array —

getSynopsis()

getSynopsis(bool  $short = false) : string

获取该指令的介绍

Parameters

bool $short

是否简洁介绍

Returns

string —

shortcutToName()

shortcutToName(string  $shortcut) : string

根据短名称获取选项名

Parameters

string $shortcut

短名称

Throws

\InvalidArgumentException

Returns

string —