thinkphp6command(⾃定义指令)
步骤:
执⾏命令:php think hello xiaoming zhangsan
1. command⽂件夹中创建⾃定义指令php class⽂件,且继承 think\console\Command类
2. 包含 configure、execute⽅法
3. config/console.php 添加命令
#使⽤控制台参数
#参数是字符串,多个参数由空格分隔,并且跟在命令名称的后⾯。参数是有顺序的,⽽且可以是可选的或必须的。例如,添加⼀个可选的 last_name 参数到命令中,并且令 name 参数必填:
#使⽤控制台参数
#参数是字符串,多个参数由空格分隔,并且跟在命令名称的后⾯。参数是有顺序的,⽽且可以是可选的或必须的。例如,添加⼀个可选的 last_name 参数到命令中,并且令 name 参数必填:
代码:
注意看参数和选项的调⽤区别
⽅式⼀:控制台调⽤
命令:php think printTest liujie 20 --num 2
⽅式⼆:控制器中调⽤
控制台输出(参数和选项)
命令⾏最有趣的部分,就是你可以利⽤参数(arguments)和选项(options)。参数和选项,能够让你从终端(terminal)向命令(command)动态地传⼊信息。
使⽤控制台参数
参数是字符串,多个参数由空格分隔,并且跟在命令名称的后⾯。参数是有顺序的,⽽且可以是可选的或必须的。例如,添加⼀个可选的 last_name 参数到命令中,并且令 name 参数必填:
<?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 ");
}
protected function execute(Input $input, Output $output)
{
// ...
}
}
现在你可以在命令中访问 last_name 参数:
<?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 ");
}
protected function execute(Input $input, Output $output)
{
$text = 'Hi ' . $input->getArgument('name');
$lastName = $input->getArgument('last_name');
if ($lastName) {
$text .= ' ' . $lastName;
}
$output->writeln($text . '!');
}
}
$  php think app:create-user kitty
Hi kitty!
$  php think app:create-user kitty cat
Hi kitty cat!
也可以让参数接收“值的列表”(⽤空格分割)。但只有最后⼀个参数才能是列表:$this
// ...
->addArgument(
'names',
Argument::IS_ARRAY,
'Who like ThinkPHP (separate multiple names with a space)?'
);
要使⽤列表,指定任意多的名字即可:
$  php think app:create-user Jim Kitty Lucy
你可以访问到作为数组的 names 参数:
$names = $input->getArgument('names');
$text = '';
if (count($names) > 0) {
$text .= ' ' . implode(', ', $names);
}
有三种参数类型可⽤:
参数类型说明
Argument::REQUIRED参数必填。如果不提供,则命令不运⾏
Argument::OPTIONAL参数可选,因此可以忽略
Argument::IS_ARRAY参数可以包含任意多个值。因此,它必须使⽤在参数列表中的最后⼀个
你可以像下⾯这样同时使⽤IS_ARRAY和REQUIRED以及OPTIONAL :
$this
// ...
->addArgument(
'names',
InputArgument::IS_ARRAY | InputArgument::REQUIRED,
'Who like ThinkPHP (separate multiple names with a space)?'
);
使⽤命令⾏选项
和参数不同,选项是没有顺序之分的 (也就是说你可以按任意顺序指定它们) ,指定选项是⽤两个中杠 (如:--key)。选项始终是可选的,⽽且可以被设置为接收⼀个值 (如:--dir=src) ,或者是⼀个布尔值⽽不需要值 (如:--key)。
例如,向⼀个“信息在⼀⾏之内应该被输出指定的次数”的命令中添加⼀个新的选项:
$this
// ...
->addOption(
'num',
null,
Option::VALUE_REQUIRED,
'How many messages should be print?',
1
);
php指什么接下来,使⽤这个命令来多次输出信息:
for ($i = 0; $i < $input->getOption('iterations'); $i++) {
$output->writeln($text);
}
完整⽰例:
<?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了:
# 不提供 --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:
$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 :
$this
// ...
->addOption(
'animals',
null,
Option::VALUE_REQUIRED | Option::VALUE_IS_ARRAY,
'Which animals do you like?',
array('cat', 'dog')
);
当你创建命令时,使⽤选项并令其可选地接受⼀个值,它是不受约束的。但是,当这个选项并没有具体值 (command --language) ,或者它根本没被使⽤ (command) 的时候,你是没有办法做到区分这些情况的。这两种情况下,此选项所收到的值都是null。

版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。