Properties

$definition

$definition : \think\console\input\Definition

Type

Definition

$options

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

Type

Option[]

$arguments

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

Type

Argument[]

$interactive

$interactive

$tokens

$tokens

$parsed

$parsed

Methods

__construct()

__construct(mixed  $argv = null) : mixed

Parameters

mixed $argv

Returns

mixed —

bind()

bind(\think\console\input\Definition  $definition) : void

绑定实例

Parameters

\think\console\input\Definition $definition

A InputDefinition instance

getFirstArgument()

getFirstArgument() : string|null

获取第一个参数

Returns

string|null —

hasParameterOption()

hasParameterOption(string|array  $values) : bool

检查原始参数是否包含某个值

Parameters

string|array $values

需要检查的值

Returns

bool —

getParameterOption()

getParameterOption(string|array  $values, mixed  $default = false) : mixed

获取原始选项的值

Parameters

string|array $values

需要检查的值

mixed $default

默认值

Returns

mixed —

The option value

validate()

validate() : mixed

验证输入

Throws

\RuntimeException

Returns

mixed —

isInteractive()

isInteractive() : bool

检查输入是否是交互的

Returns

bool —

setInteractive()

setInteractive(bool  $interactive) : void

设置输入的交互

Parameters

bool $interactive

getArguments()

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

获取所有的参数

Returns

\think\console\input\Argument[] —

getArgument()

getArgument(string  $name) : mixed

根据名称获取参数

Parameters

string $name

参数名

Throws

\InvalidArgumentException

Returns

mixed —

setArgument()

setArgument(string  $name, string  $value) : mixed

设置参数的值

Parameters

string $name

参数名

string $value

Throws

\InvalidArgumentException

Returns

mixed —

hasArgument()

hasArgument(string|int  $name) : bool

检查是否存在某个参数

Parameters

string|int $name

参数名或位置

Returns

bool —

getOptions()

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

获取所有的选项

Returns

\think\console\input\Option[] —

getOption()

getOption(string  $name) : mixed

获取选项值

Parameters

string $name

选项名称

Throws

\InvalidArgumentException

Returns

mixed —

setOption()

setOption(string  $name, string|bool  $value) : void

设置选项值

Parameters

string $name

选项名

string|bool $value

Throws

\InvalidArgumentException

hasOption()

hasOption(string  $name) : bool

是否有某个选项

Parameters

string $name

选项名

Returns

bool —

escapeToken()

escapeToken(string  $token) : string

转义指令

Parameters

string $token

Returns

string —

__toString()

__toString() : string

返回传递给命令的参数的字符串

Returns

string —

setTokens()

setTokens(array  $tokens) : mixed

Parameters

array $tokens

Returns

mixed —

parse()

parse() : void

解析参数

parseShortOption()

parseShortOption(string  $token) : void

解析短选项

Parameters

string $token

当前的指令.

parseShortOptionSet()

parseShortOptionSet(string  $name) : void

解析短选项

Parameters

string $name

当前指令

Throws

\RuntimeException

parseLongOption()

parseLongOption(string  $token) : void

解析完整选项

Parameters

string $token

当前指令

parseArgument()

parseArgument(string  $token) : void

解析参数

Parameters

string $token

当前指令

Throws

\RuntimeException

addShortOption()

addShortOption(string  $shortcut, mixed  $value) : void

添加一个短选项的值

Parameters

string $shortcut

短名称

mixed $value

Throws

\RuntimeException

addLongOption()

addLongOption(string  $name, mixed  $value) : void

添加一个完整选项的值

Parameters

string $name

选项名

mixed $value

Throws

\RuntimeException