前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >3分钟短文:胆儿真肥!Laravel在命令行问用户要数据!

3分钟短文:胆儿真肥!Laravel在命令行问用户要数据!

原创
作者头像
程序员小助手
修改2020-10-28 10:53:17
8470
修改2020-10-28 10:53:17
举报
文章被收录于专栏:程序员小助手程序员小助手

引言

上一章我教会大家如何在3分钟的时间,通过laravel跻身geek之列(听一下就好[捂嘴.jpg])。实现了一个简单的命令行,和一个复杂的发送邮件通知的功能。 可是细心的读者你发现了没有,使用自定义的命令行,全程我们没有输入一个参数,没有一个数据,这,这,这,太不寻常了吧

img
img

linux下的命令,没有一个是不带参数自己玩儿的!所以本文教你改造命令行,做一个标准的应用程序。

事前询问

首先我们要区分获取参数的两种方式,一种是在输入命令行时直接给定的,还有一种是在程序运行过程中,等待用户输入信息之后才能继续。 先说第一种方式,也分为两种,一种叫参数 argument,一种叫选项 option。在laravel程序里,这两个名字没有变化。

比如,有一个密码重置的命令行工具,要求传入一个 userId 用于标记用户的身份,在类的声明中指明使用方式:

代码语言:javascript
复制
protected $signature = 'password:reset {userId}';

假设上述类已经完成功能开发,在命令行中调用:

代码语言:javascript
复制
php artisan password:reset 5

在代码中使用 $this->argument() 方法,打印其结果是一个数组,内容如下:

代码语言:javascript
复制
[
    "command": "password:reset",
    "userId': "5",
]

如果要返回指定的参数值,只需传入键名即可:

代码语言:javascript
复制
$this->argument('userId'); // 5

返回的就是命令行上传送的参数。这个 {userId} 的写法就是 argument,称为 参数

还有一种方式是选项 option,声明的时候,要在方法内这样写:

代码语言:javascript
复制
protected $signature = 'password:reset {--userId=}';

这就是声明一个选项了,使用命令行的时候数据传送方式也不一样:

代码语言:javascript
复制
php artisan password:reset --userId=5

程序里要用 $this->option() 来获取,打印数组内容如下:

代码语言:javascript
复制
[
    "userId" => "5"
    "help" => false
    "quiet" => false
    "verbose" => false
    "version" => false
    "ansi" => false
    "no-ansi" => false
    "no-interaction" => false
    "env" => null
]

比 argument 打印的内容丰富的多,为什么?因为那些事laravel Command 类默认追加上的,只要继承了基类都天然自带这些选项。

用法类似,获取单个的选项值,只要传入键名就可以了:

代码语言:javascript
复制
$this->option('userId');

为了演示两个方法的用法,我们为命令行调用方式声明两种获取参数的方式:

代码语言:javascript
复制
protected $signature = 'password:reset {userId : user ID} {--sendEmail : Send email or NOT}';

在程序里我们要分别获取,下面是手动实现 handle 处理方法:

代码语言:javascript
复制
public function handle()
{
    // 所有参数
    $arguments = $this->argument();
    $userid = $this->argument('userId');
    
    // 所有选项
    $options = $this->option();
    $sendEmail = $this->option('sendEmail');
}

事中确认

有些参数是要在程序运行中对用户进行询问,下面就介绍几个常用的方法。

ask方法需要用户输入字符串内容:

代码语言:javascript
复制
$email = $this->ask('What is your email address?');

如果输入的是密码敏感数据,默认是不能展示在终端的,使用 secret方法:

代码语言:javascript
复制
$password = $this->secret('What is the password?');

有时候是询问用户是或者否,那就用 confirm方法:

代码语言:javascript
复制
if ($this->confirm('Do you want to reset the password?')) {
//
}

还有一些,尽量减少用户输入,使用选项的方式,让用户选,这样输入的采集数据基本不会出错。使用 choice方法:

代码语言:javascript
复制
$level = $this->choice('What is the level?', ['low', 'middle', 'high'], 0);

有这几个助阵,基本上够用了,做一个有些复杂的中型的命令行工具,只要PHP还运行的动,处理的来,基本没啥问题。

写在最后

本文我们讲述了两个重要的概念,参数和选项。在设计命令行的时候一定要想清楚,规划好,到底用哪一个,在代码中才能有的放矢地读取。并且使用询问等待可以制作更多灵活的引导型程序,非常实用。

Happy coding :-)

我是@程序员小助手,专注编程知识,圈子动态的IT领域原创作者

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 引言
  • 事前询问
  • 事中确认
  • 写在最后
相关产品与服务
命令行工具
腾讯云命令行工具 TCCLI 是管理腾讯云资源的统一工具。使用腾讯云命令行工具,您可以快速调用腾讯云 API 来管理您的腾讯云资源。此外,您还可以基于腾讯云的命令行工具来做自动化和脚本处理,以更多样的方式进行组合和重用。
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档