玖叶教程网

前端编程开发入门

3分钟短文:Laravel命令行参数和可选项分不清?怎么可能

引言

上一期我们介绍了laravel命令行的创建,以及使用方法。使用了一个没有数据输入和输出的测试用例。 本期我们来介绍带有命令行参数输入,和命令行输出信息的代码用法。



代码时间

声明命令行位置参数,在类文件内$signature变量内书写:

protected $signature = 'password:reset {userId} {--sendEmail}';

其中 userId 是必填参数,需要填入一个数据;而 sendEmail 则是一个开关, 如果在命令行中带有 --sendEmail 则返回true,否则返回默认值。

对于常用的位置参数,如果想要对 userId 设置为可选,这样写:

password:reset {userId?}

如果要给其设置一个默认值,这样来写:

password:reset {userId=1}

对于可选项(比如 --password) 需要用户手动输入一个值,这样写:

password:reset {userId} {--password=}

加一个等号即可。如果可选项有默认值,等号传递上即可:

password:reset {userId} {--queue=default}

如果要使用一个命令行参数,接收一系列值,也就是一个数组,这样来声明:

password:reset {userIds*}

用的使用需要使用空格将各个参数排开:

php artisan password:reset 1 2 3

如果是可选项参数,则声明如下:

password:reset {--ids=*}

使用起来的时候,比较人性化,我们推荐这种用法,也是linux操作系统下的惯例:

php artisan password:reset --ids=1 --ids=2 --ids=3

这样要直观的多。

演示示例

假设命令行文件内声明的参数类型如下:

password:reset {userId}

那么在程序内要获取命令行的该参数,需要$this->argument()方法,返回的是一个数组:

[
    "command": "password:reset",
    "userId': "5",
]

获取单个参数的值:

$userId = $this->argument('userId');

对于可选项的值,文件内声明如下:

password:reset {--userId=}

首先我们打印多有的可选项$this->option()数据:

[
    "userId" => "5"
    "help" => false
    "quiet" => false
    "verbose" => false
    "version" => false
    "ansi" => false
    "no-ansi" => false
    "no-interaction" => false
    "env" => null
]

如果是获取单个可选项参数,在方法内指定即可:

$userId = $this->option('userId');

写在最后

本文使用对比的方式,为大家演示了命令行的argumentoption的区别, 在用法上我们更推荐使用 option 获取用户输入,这样更符合linux的设计哲学和惯例。

Happy coding :-)


我是@程序员小助手,持续分享编程知识,欢迎关注。

发表评论:

控制面板
您好,欢迎到访网站!
  查看权限
网站分类
最新留言