\think\consoleInput

Summary

Methods

Properties

Constants

__construct()
bind()
getFirstArgument()
hasParameterOption()
getParameterOption()
validate()
isInteractive()
setInteractive()
getArguments()
getArgument()
setArgument()
hasArgument()
getOptions()
getOption()
setOption()
hasOption()
escapeToken()
__toString()

No public properties found

No constants found

setTokens()
parse()

$definition
$options
$arguments
$interactive

N/A

parseShortOption()
parseShortOptionSet()
parseLongOption()
parseArgument()
addShortOption()
addLongOption()

$tokens
$parsed

N/A

File: vendor/topthink/framework/src/think/console/Input.php
Package: Default
Class hierarchy: \think\console\Input

Properties

$definition

$definition : \think\console\input\Definition

Type

\think\console\input\Definition

$options

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

Type

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

$arguments

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

Type

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

$interactive

$interactive :

Type

$tokens

$tokens :

Type

$parsed

$parsed :

Type

Methods

__construct()

__construct(  $argv = null)

Parameters

$argv

bind()

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

绑定实例

Parameters

\think\console\input\Definition

$definition

A InputDefinition instance

getFirstArgument()

getFirstArgument() : string|null

获取第一个参数

Returns

string|null

hasParameterOption()

hasParameterOption(string|array  $values) : boolean

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

Parameters

string|array

$values

需要检查的值

Returns

boolean

getParameterOption()

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

获取原始选项的值

Parameters

string\|array	$values	需要检查的值
mixed	$default	默认值

Returns

mixed —

The option value

validate()

validate()

验证输入

Throws

\RuntimeException

isInteractive()

isInteractive() : boolean

检查输入是否是交互的

Returns

boolean

setInteractive()

setInteractive(\think\console\bool  $interactive)

设置输入的交互

Parameters

\think\console\bool

$interactive

getArguments()

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

获取所有的参数

Returns

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

getArgument()

getArgument(string  $name) : mixed

根据名称获取参数

Parameters

string

$name

参数名

Throws

\InvalidArgumentException

Returns

mixed

setArgument()

setArgument(string  $name, string  $value)

设置参数的值

Parameters

string	$name	参数名
string	$value	值

Throws

\InvalidArgumentException

hasArgument()

hasArgument(string|integer  $name) : boolean

检查是否存在某个参数

Parameters

string|integer

$name

参数名或位置

Returns

boolean

getOptions()

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

获取所有的选项

Returns

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

getOption()

getOption(string  $name) : mixed

获取选项值

Parameters

string

$name

选项名称

Throws

\InvalidArgumentException

Returns

mixed

setOption()

setOption(string  $name, string|boolean  $value)

设置选项值

Parameters

string	$name	选项名
string\|boolean	$value	值

Throws

\InvalidArgumentException

hasOption()

hasOption(string  $name) : boolean

是否有某个选项

Parameters

string

$name

选项名

Returns

boolean

escapeToken()

escapeToken(string  $token) : string

转义指令

Parameters

string

$token

Returns

string

__toString()

__toString() : string

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

Returns

string

setTokens()

setTokens(array  $tokens)

Parameters

array

$tokens

parse()

parse()

解析参数

parseShortOption()

parseShortOption(string  $token)

解析短选项

Parameters

string

$token

当前的指令.

parseShortOptionSet()

parseShortOptionSet(string  $name)

解析短选项

Parameters

string

$name

当前指令

Throws

\RuntimeException

parseLongOption()

parseLongOption(string  $token)

解析完整选项

Parameters

string

$token

当前指令

parseArgument()

parseArgument(string  $token)

解析参数

Parameters

string

$token

当前指令

Throws

\RuntimeException

addShortOption()

addShortOption(string  $shortcut, mixed  $value)

添加一个短选项的值

Parameters

string	$shortcut	短名称
mixed	$value	值

Throws

\RuntimeException

addLongOption()

addLongOption(string  $name, mixed  $value)

添加一个完整选项的值

Parameters

string	$name	选项名
mixed	$value	值

Throws

\RuntimeException