Laravel Artisan 命令行:参数和选项说明 1 个改进

问题

如何象 artisan 自带命令那样为参数和选项设置说明?

回答

在用户的自定义命令中,是支持象 artisan 自带命令那样设置参数和选项说明的。

参数说明语法

{参数名 : 参数说明}

注意,分隔 参数名参数说明 的冒号两边必须加空格。

选项说明语法

{--选项名 : 选项说明}

注意,分隔 选项名选项说明 的冒号两边必须加空格。

示例

下面的代码以闭包命令形式创建一个 hash:md5 命令,为 text 参数设置说明 Calculate text,为 --uppercase 选项设置说明 Output uppercase hash value

Artisan::command('hash:md5 {text : Calculate text} {--U|uppercase : Output uppercase hash value}', function ($text, $uppercase) {
    $md5text = $uppercase ? strtoupper(md5($text)) : md5($text);

    $this->info("md5('{$text}') = $md5text");
})->describe('Calculate the md5 hash of a text');

参考

本文为 Wiki 文章,邀您参与纠错、纰漏和优化
讨论数量: 0
(= ̄ω ̄=)··· 暂无内容!

讨论应以学习和精进为目的。请勿发布不友善或者负能量的内容,与人为善,比聪明更重要!