ThinkPHP5


think\console\Input
library\think\console\Input.php at line 18

Class Input

Input

public class Input


Constructor Summary
void

__construct(mixed argv)

Method Summary
protected void

setTokens(mixed tokens)

void

bind(Definition definition)

绑定实例

protected void

parse()

解析参数

string|null

getFirstArgument()

获取第一个参数

bool

hasParameterOption(string|array values)

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

mixed

getParameterOption(string|array values, mixed default)

获取原始选项的值

void

validate()

验证输入

bool

isInteractive()

检查输入是否是交互的

void

setInteractive(bool interactive)

设置输入的交互

Argument[]

getArguments()

获取所有的参数

mixed

getArgument(string name)

根据名称获取参数

void

setArgument(string name, string value)

设置参数的值

bool

hasArgument(string|int name)

检查是否存在某个参数

Option[]

getOptions()

获取所有的选项

mixed

getOption(string name)

获取选项值

void

setOption(string name, string|bool value)

设置选项值

bool

hasOption(string name)

是否有某个选项

string

escapeToken(string token)

转义指令

Constructor Detail

library\think\console\Input.php at line 41

__construct

public void __construct(mixed argv)

Method Detail

library\think\console\Input.php at line 54

setTokens

protected void setTokens(mixed tokens)

library\think\console\Input.php at line 63

bind

public void bind(Definition definition)

绑定实例

Parameters:
definition - A InputDefinition instance

library\think\console\Input.php at line 75

parse

protected void parse()

解析参数


library\think\console\Input.php at line 246

getFirstArgument

public string|null getFirstArgument()

获取第一个参数


library\think\console\Input.php at line 263

hasParameterOption

public bool hasParameterOption(string|array values)

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

Parameters:
values - 需要检查的值

library\think\console\Input.php at line 284

getParameterOption

public mixed getParameterOption(string|array values, mixed default)

获取原始选项的值

Parameters:
values - 需要检查的值
default - 默认值
Returns:
The option value

library\think\console\Input.php at line 310

validate

public void validate()

验证输入

Throws:
\RuntimeException

library\think\console\Input.php at line 321

isInteractive

public bool isInteractive()

检查输入是否是交互的


library\think\console\Input.php at line 330

setInteractive

public void setInteractive(bool interactive)

设置输入的交互


library\think\console\Input.php at line 339

getArguments

public Argument[] getArguments()

获取所有的参数


library\think\console\Input.php at line 350

getArgument

public mixed getArgument(string name)

根据名称获取参数

Parameters:
name - 参数名
Throws:
\InvalidArgumentException

library\think\console\Input.php at line 366

setArgument

public void setArgument(string name, string value)

设置参数的值

Parameters:
name - 参数名
value - 值
Throws:
\InvalidArgumentException

library\think\console\Input.php at line 380

hasArgument

public bool hasArgument(string|int name)

检查是否存在某个参数

Parameters:
name - 参数名或位置

library\think\console\Input.php at line 389

getOptions

public Option[] getOptions()

获取所有的选项


library\think\console\Input.php at line 400

getOption

public mixed getOption(string name)

获取选项值

Parameters:
name - 选项名称
Throws:
\InvalidArgumentException

library\think\console\Input.php at line 415

setOption

public void setOption(string name, string|bool value)

设置选项值

Parameters:
name - 选项名
value - 值
Throws:
\InvalidArgumentException

library\think\console\Input.php at line 429

hasOption

public bool hasOption(string name)

是否有某个选项

Parameters:
name - 选项名

library\think\console\Input.php at line 439

escapeToken

public string escapeToken(string token)

转义指令


ThinkPHP5