$input
$input : \think\console\Input
$input : \think\console\Input
$output : \think\console\Output
$console : \think\Console
setConsole(\think\Console $console = null)
设置控制台
| \think\Console | $console |
getConsole() : \think\Console
获取控制台
run(\think\console\Input $input, \think\console\Output $output) : integer
执行
| \think\console\Input | $input | |
| \think\console\Output | $output |
setCode(callable $code) : \think\console\Command
设置执行代码
| callable | $code | callable(InputInterface $input, OutputInterface $output) |
setDefinition(array|\think\console\input\Definition $definition) : \think\console\Command
设置参数定义
| array|\think\console\input\Definition | $definition |
getDefinition() : \think\console\input\Definition
获取参数定义
getNativeDefinition() : \think\console\input\Definition
获取当前指令的参数定义
addArgument(string $name, integer $mode = null, string $description = '', mixed $default = null) : \think\console\Command
添加参数
| string | $name | 名称 |
| integer | $mode | 类型 |
| string | $description | 描述 |
| mixed | $default | 默认值 |
addOption(string $name, string $shortcut = null, integer $mode = null, string $description = '', mixed $default = null) : \think\console\Command
添加选项
| string | $name | 选项名称 |
| string | $shortcut | 别名 |
| integer | $mode | 类型 |
| string | $description | 描述 |
| mixed | $default | 默认值 |
setName(string $name) : \think\console\Command
设置指令名称
| string | $name |
setDescription(string $description) : \think\console\Command
设置描述
| string | $description |
setHelp(string $help) : \think\console\Command
设置帮助信息
| string | $help |
setAliases(array<mixed,string> $aliases) : \think\console\Command
设置别名
| array<mixed,string> | $aliases |
setCommand(\think\console\Command $command)
Sets the command.
| \think\console\Command | $command | The command to set |
execute(\think\console\Input $input, \think\console\Output $output) : null|integer
执行指令
| \think\console\Input | $input | |
| \think\console\Output | $output |
interact(\think\console\Input $input, \think\console\Output $output)
用户验证
| \think\console\Input | $input | |
| \think\console\Output | $output |
initialize(\think\console\Input $input, \think\console\Output $output)
初始化
| \think\console\Input | $input | An InputInterface instance |
| \think\console\Output | $output | An OutputInterface instance |
<?php
// +----------------------------------------------------------------------
// | ThinkPHP [ WE CAN DO IT JUST THINK ]
// +----------------------------------------------------------------------
// | Copyright (c) 2006~2015 http://thinkphp.cn All rights reserved.
// +----------------------------------------------------------------------
// | Licensed ( http://www.apache.org/licenses/LICENSE-2.0 )
// +----------------------------------------------------------------------
// | Author: yunwuxin <448901948@qq.com>
// +----------------------------------------------------------------------
namespace think\console\command;
use think\console\Command;
use think\console\Input;
use think\console\input\Argument as InputArgument;
use think\console\input\Option as InputOption;
use think\console\Output;
class Help extends Command
{
private $command;
/**
* {@inheritdoc}
*/
protected function configure()
{
$this->ignoreValidationErrors();
$this->setName('help')->setDefinition([
new InputArgument('command_name', InputArgument::OPTIONAL, 'The command name', 'help'),
new InputOption('raw', null, InputOption::VALUE_NONE, 'To output raw command help'),
])->setDescription('Displays help for a command')->setHelp(<<<EOF
The <info>%command.name%</info> command displays help for a given command:
<info>php %command.full_name% list</info>
To display the list of available commands, please use the <info>list</info> command.
EOF
);
}
/**
* Sets the command.
* @param Command $command The command to set
*/
public function setCommand(Command $command)
{
$this->command = $command;
}
/**
* {@inheritdoc}
*/
protected function execute(Input $input, Output $output)
{
if (null === $this->command) {
$this->command = $this->getConsole()->find($input->getArgument('command_name'));
}
$output->describe($this->command, [
'raw_text' => $input->getOption('raw'),
]);
$this->command = null;
}
}