如何从Laravel命令输出到终端选项及其描述

时间:2018-01-14 16:27:38

标签: php laravel laravel-5 laravel-5.5

从Laravel文档中,您可以创建自己的artisan commands并添加带说明的参数

  

{ - param =:description}

例如,如果用户没有输入必需参数,我想显示此参数,并且描述就像在$ signature属性中定义一样。

我该怎么做?

1 个答案:

答案 0 :(得分:2)

您可以使用-h--help选项显示命令的所有可用选项:

php artisan yourcommand -h

要向参数添加说明,请使用以下语法:

protected $signature = 'yourcommand {someargument : Description of option}';

如果要以编程方式执行此操作,请在命令类中创建一个公共方法:

public function help()
{
    // Display all arguments with descriptions.
    foreach($this->getDefinition()->getArguments() as $name => $description) {
        echo $name . ' - ' . $description->getDescription();
    };

    // Display all options with descriptions.
    foreach($this->getDefinition()->getOptions() as $name => $description) {
        echo $name . ' - ' . $description->getDescription();
    };
}

然后从您的代码中调用它:

app('\App\Console\Commands\YourCommand')->help();