步骤:
执行命令:php think hello xiaoming zhangsan
1\. command文件夹中创建自定义指令php class文件,且继承 think\\console\\Command类
2\. 包含 configure、execute方法
3\. config/console.php 添加命令
![](https://img.kancloud.cn/7d/06/7d063585d047ac9c2d6770ad853891d1_1626x542.png)
#使用控制台参数
#参数是字符串,多个参数由空格分隔,并且跟在命令名称的后面。参数是有顺序的,而且可以是可选的或必须的。例如,添加一个可选的 last\_name 参数到命令中,并且令 name 参数必填:
#使用控制台参数
#参数是字符串,多个参数由空格分隔,并且跟在命令名称的后面。参数是有顺序的,而且可以是可选的或必须的。例如,添加一个可选的 last\_name 参数到命令中,并且令 name 参数必填:
代码:
![](https://img.kancloud.cn/59/10/591030da98014434d46bbd5d65dfc445_2872x1750.png)
注意看参数和选项的调用区别
方式一:控制台调用
命令:php think printTest liujie 20 --num 2
![](https://img.kancloud.cn/56/3d/563d1ff080bbdebe10e7fb8578bde859_2564x400.png)
方式二:控制器中调用
![](https://img.kancloud.cn/ba/12/ba12d191be3f1f99121707f017abe0ee_1116x705.png)
# 控制台输出(参数和选项)
命令行最有趣的部分,就是你可以利用参数(`arguments`)和选项(`options`)。参数和选项,能够让你从终端(`terminal`)向命令(`command`)动态地传入信息。
## 使用控制台参数
参数是字符串,多个参数由空格分隔,并且跟在命令名称的后面。参数是有顺序的,而且可以是可选的或必须的。例如,添加一个可选的 last\_name 参数到命令中,并且令 name 参数必填:
~~~php
<?php
namespace app\console;
use think\console\Command;
use think\console\Input;
use think\console\input\Argument;
use think\console\Output;
class CreateUser extends Command
{
// ...
protected function configure()
{
$this
// 命令的名字("think" 后面的部分)
->setName('app:create-user')
// 配置一个参数
->addArgument('name', Argument::REQUIRED, 'Do you like ThinkPHP')
->addArgument('last_name', Argument::OPTIONAL, 'Your last name?')
// 运行 "php think list" 时的简短描述
->setDescription('Creates new users.')
// 运行命令时使用 "--help" 选项时的完整命令描述
->setHelp("This command allows you to create users...");
}
protected function execute(Input $input, Output $output)
{
// ...
}
}
~~~
现在你可以在命令中访问 last\_name 参数:
~~~php
<?php
namespace app\console;
use think\console\Command;
use think\console\Input;
use think\console\input\Argument;
use think\console\Output;
class CreateUser extends Command
{
// ...
protected function configure()
{
$this
// 命令的名字("think" 后面的部分)
->setName('app:create-user')
// 配置一个参数
->addArgument('name', Argument::REQUIRED, 'Who like ThinkPHP ?')
->addArgument('last_name', Argument::OPTIONAL, 'Your last name?')
// 运行 "php think list" 时的简短描述
->setDescription('Creates new users.')
// 运行命令时使用 "--help" 选项时的完整命令描述
->setHelp("This command allows you to create users...");
}
protected function execute(Input $input, Output $output)
{
$text = 'Hi ' . $input->getArgument('name');
$lastName = $input->getArgument('last_name');
if ($lastName) {
$text .= ' ' . $lastName;
}
$output->writeln($text . '!');
}
}
~~~
~~~sql
$ php think app:create-user kitty
Hi kitty!
$ php think app:create-user kitty cat
Hi kitty cat!
~~~
也可以让参数接收“值的列表”(用空格分割)。但只有最后一个参数才能是列表:
~~~kotlin
$this
// ...
->addArgument(
'names',
Argument::IS_ARRAY,
'Who like ThinkPHP (separate multiple names with a space)?'
);
~~~
要使用列表,指定任意多的名字即可:
~~~sql
$ php think app:create-user Jim Kitty Lucy
~~~
你可以访问到作为数组的 names 参数:
~~~bash
$names = $input->getArgument('names');
$text = '';
if (count($names) > 0) {
$text .= ' ' . implode(', ', $names);
}
~~~
有三种参数类型可用:
| 参数类型 | 说明 |
| --- | --- |
| `Argument::REQUIRED` | 参数必填。如果不提供,则命令不运行 |
| `Argument::OPTIONAL` | 参数可选,因此可以忽略 |
| `Argument::IS_ARRAY` | 参数可以包含任意多个值。因此,它必须使用在参数列表中的最后一个 |
你可以像下面这样同时使用 `IS_ARRAY` 和 `REQUIRED` 以及 `OPTIONAL` :
~~~php
$this
// ...
->addArgument(
'names',
InputArgument::IS_ARRAY | InputArgument::REQUIRED,
'Who like ThinkPHP (separate multiple names with a space)?'
);
~~~
## 使用命令行选项
和参数不同,选项是没有顺序之分的 (也就是说你可以按任意顺序指定它们) ,指定选项是用两个中杠 (如:`--key`)。
选项 *始终* 是可选的,而且可以被设置为接收一个值 (如:`--dir=src`) ,或者是一个布尔值而不需要值 (如:`--key`)。
例如,向一个“信息在一行之内应该被输出指定的次数”的命令中添加一个新的选项:
~~~kotlin
$this
// ...
->addOption(
'num',
null,
Option::VALUE_REQUIRED,
'How many messages should be print?',
1
);
~~~
接下来,使用这个命令来多次输出信息:
~~~bash
for ($i = 0; $i < $input->getOption('iterations'); $i++) {
$output->writeln($text);
}
~~~
完整示例:
~~~php
<?php
namespace app\console;
use think\console\Command;
use think\console\Input;
use think\console\input\Argument;
use think\console\input\Option;
use think\console\Output;
class CreateUser extends Command
{
// ...
protected function configure()
{
$this
// 命令的名字("think" 后面的部分)
->setName('app:create-user')
// 配置一个参数
->addArgument('name', Argument::REQUIRED, 'Who like ThinkPHP ?')
// 配置一个选项
->addOption(
'num',
null,
Option::VALUE_REQUIRED,
'How many messages should be print?',
1
);
}
protected function execute(Input $input, Output $output)
{
$text = 'Hi ' . $input->getArgument('name');
for ($i = 0; $i < $input->getOption('num'); $i++) {
$output->writeln($text);
}
}
}
~~~
现在,运行命令时,你可以可选地指定一个 `--num` 了:
~~~sql
# 不提供 --num,使用的默认值是(1)
$ php think app:create-user kitty
Hi kitty
$ php think app:create-user kitty --num=7
Hi kitty
Hi kitty
Hi kitty
Hi kitty
Hi kitty
Hi kitty
Hi kitty
# 选项的顺序是任意的的
$ php think app:create-user kitty --num=7 --key
$ php think app:create-user kitty --key --num=7
$ php think app:create-user --key --num=7 kitty
~~~
> 你还可以为选项声明一个“以单个中杠开头”的单字符的快捷方式,比如 `-n`:
~~~kotlin
$this
// ...
->addOption(
'num',
'n',
Option::VALUE_REQUIRED,
'How many messages should be print?',
1
);
~~~
选项 支持四种类型:
| 选项类型 | 说明 | 示例 |
| --- | --- | --- |
| `Option::VALUE_IS_ARRAY` | 此选项可接收多个值 | \--dir=/foo --dir=/bar |
| `Option::VALUE_NONE` | 此选项不接受输入的值 | \--key |
| `Option::VALUE_REQUIRED` | 此选项的值必填,但选项本身仍然是可选的 | \--num=7 |
| `Option::VALUE_OPTIONAL` | 此选项的值可有可无 | \--key 或 --key=value |
你可以像下面这样同时使用 `VALUE_IS_ARRAY` 和 `VALUE_REQUIRED` 或 `VALUE_OPTIONAL` :
~~~php
$this
// ...
->addOption(
'animals',
null,
Option::VALUE_REQUIRED | Option::VALUE_IS_ARRAY,
'Which animals do you like?',
array('cat', 'dog')
);
~~~
> 当你创建命令时,使用选项并令其可选地接受一个值,它是不受约束的。但是,当这个选项并没有具体值 (`command --language`) ,或者它根本没被使用 (`command`) 的时候,你是没有办法做到区分这些情况的。这两种情况下,此选项所收到的值都是 `null`。
- thinkphp6执行流程(一)
- php中use关键字用法详解
- Thinkphp6使用腾讯云发送短信步骤
- 路由配置
- Thinkphp6,static静态资源访问路径问题
- ThinkPHP6.0+ 使用Redis 原始用法
- smarty在thinkphp6.0中的最佳实践
- Thinkphp6.0 搜索器使用方法
- 从已有安装包(vendor)恢复 composer.json
- tp6with的用法,表间关联查询
- thinkphp6.x多对多如何添加中间表限制条件
- thinkphp6 安装JWT
- 缓存类型
- 请求信息和HTTP头信息
- 模型事件用法
- 助手函数汇总
- tp6集成Alipay 手机和电脑端支付的方法
- thinkphp6使用jwt
- 6.0session cookie cache
- tp6笔记
- TP6(thinkphp6)队列与延时队列
- thinkphp6 command(自定义指令)
- command(自定义指令)
- 本地文件上传
- 缓存
- 响应
- 公共函数配置
- 七牛云+文件上传
- thinkphp6:访问多个redis数据源(thinkphp6.0.5 / php 7.4.9)
- 富文本编辑器wangEditor3
- IP黑名单
- 增删改查 +文件上传
- workerman 定时器操作控制器的方法
- 上传文件到阿里云oss
- 短信或者邮箱验证码防刷代码
- thinkphp6:访问redis6(thinkphp 6.0.9/php 8.0.14)
- 实现关联多个id以逗号分开查询数据
- thinkphp6实现邮箱注册功能的细节和代码(点击链接激活方式)
- 用mpdf生成pdf文件(php 8.1.1 / thinkphp v6.0.10LTS )
- 生成带logo的二维码(php 8.1.1 / thinkphp v6.0.10LTS )
- mysql数据库使用事务(php 8.1.1 / thinkphp v6.0.10LTS)
- 一,创建过滤IP的中间件
- 源码解析请求流程
- 验证码生成
- 权限管理
- 自定义异常类
- 事件监听event-listene
- 安装与使用think-addons
- 事件与多应用
- Workerman 基本使用
- 查询用户列表按拼音字母排序
- 扩展包合集
- 查询用户数据,但是可以通过输入用户昵称来搜索用户同时还要统计用户的文章和粉丝数
- 根据图片的minetype类型获取文件真实拓展名思路
- 到处excel
- 用imagemagick库生成缩略图
- 生成zip压缩包并下载
- API 多版本控制
- 用redis+lua做限流(php 8.1.1 / thinkphp v6.0.10LTS )
- 【thinkphp6源码分析三】 APP类之父, 容器Container类
- thinkphp6表单重复提交解决办法
- 小程序授权
- 最简单的thinkphp6导出Excel
- 根据访问设备不同访问不同模块
- 服务系统
- 前置/后置中间件
- 给接口api做签名验证(php 8.1.1 / thinkphp v6.0.10LTS )
- 6实现邮箱注册功能的细节和代码(点击链接激活方式)
- 使用前后端分离的验证码(thinkphp 6.0.9/php 8.0.14/vue 3.2.26)
- 前后端分离:用jwt+middleware做用户登录验证(php 8.1.1 / thinkphp v6.0.10LTS )
- vue前后端分离多图上传
- thinkphp 分组、页面跳转与ajax
- thinkphp6 常用方法文档
- 手册里没有的一些用法
- Swagger 3 API 注释
- PHP 秒级定时任务
- thinkphp6集成gatewayWorker(workerman)实现实时监听
- thinkphp6按月新增数据表
- 使用redis 实现消息队列
- api接口 统一结果返回处理类
- 使用swoole+thinkphp6.0+redis 结合开发的登录模块
- 给接口api做签名验证
- ThinkPHP6.0 + UniApp 实现小程序的 微信登录
- ThinkPHP6.0 + Vue + ElementUI + axios 的环境安装到实现 CURD 操作!
- 异常$e
- 参数请求验证自定义和异常错误自定义