Command
public class Command
| Constructor Summary | |
|---|---|
| void | __construct(string|null name) 构造方法 |
| Method Summary | |
|---|---|
| void | 忽略验证错误 |
| void | setConsole(Console console) 设置控制台 |
| Console | 获取控制台 |
| bool | 是否有效 |
| protected void | 配置指令 |
| protected null|int | execute(Input input, Output output) 执行指令 |
| protected void | interact(Input input, Output output) 用户验证 |
| protected void | initialize(Input input, Output output) 初始化 |
| int | run(Input input, Output output) 执行 |
| Command | setCode(callable code) 设置执行代码 |
| void | mergeConsoleDefinition(bool mergeArgs) 合并参数定义 |
| Command | setDefinition(array|Definition definition) 设置参数定义 |
| Definition | 获取参数定义 |
| Definition | 获取当前指令的参数定义 |
| Command | addArgument(string name, int mode, string description, mixed default) 添加参数 |
| Command | addOption(string name, string shortcut, int mode, string description, mixed default) 添加选项 |
| Command | setName(string name) 设置指令名称 |
| string | getName() 获取指令名称 |
| Command | setDescription(string description) 设置描述 |
| string | 获取描述 |
| Command | setHelp(string help) 设置帮助信息 |
| string | getHelp() 获取帮助信息 |
| string | 描述信息 |
| Command | setAliases(string aliases) 设置别名 |
| array | 获取别名 |
| string | getSynopsis(bool short) 获取简介 |
| $this | addUsage(string usage) 添加用法介绍 |
| array | 获取用法介绍 |
public void __construct(string|null name)
构造方法
public void ignoreValidationErrors()
忽略验证错误
public void setConsole(Console console)
设置控制台
public Console getConsole()
获取控制台
public bool isEnabled()
是否有效
protected void configure()
配置指令
protected null|int execute(Input input, Output output)
执行指令
protected void interact(Input input, Output output)
用户验证
protected void initialize(Input input, Output output)
初始化
public int run(Input input, Output output)
执行
public Command setCode(callable code)
设置执行代码
public void mergeConsoleDefinition(bool mergeArgs)
合并参数定义
public Command setDefinition(array|Definition definition)
设置参数定义
public Definition getDefinition()
获取参数定义
public Definition getNativeDefinition()
获取当前指令的参数定义
public Command addArgument(string name, int mode, string description, mixed default)
添加参数
public Command addOption(string name, string shortcut, int mode, string description, mixed default)
添加选项
public Command setName(string name)
设置指令名称
public string getName()
获取指令名称
public Command setDescription(string description)
设置描述
public string getDescription()
获取描述
public Command setHelp(string help)
设置帮助信息
public string getHelp()
获取帮助信息
public string getProcessedHelp()
描述信息
public Command setAliases(string aliases)
设置别名
public array getAliases()
获取别名
public string getSynopsis(bool short)
获取简介
public $this addUsage(string usage)
添加用法介绍
public array getUsages()
获取用法介绍