Yii2控制台命令需重写options()方法声明允许的选项名(如'env'),才能使用--option形式参数;位置参数按顺序映射到action方法参数,或通过getArgs()获取全部。

Yii2 控制台命令怎么接收 --option 形式的参数
Yii2 的 yii\console\Controller 默认支持 POSIX 风格的选项解析,但必须显式声明才能生效。不声明就直接用 --env=prod 会报错:Unknown option: --env。
关键在重写 options() 方法,返回一个数组,列出你允许的选项名(不含 --):
public function options($id)
{
return array_merge(parent::options($id), ['env', 'force']);
}
之后就能在 actionIndex() 里通过 $this->env、$this->force 直接取值。注意:这些属性会自动被赋值,不需要手动解析 $argv。
-
--env=prod和--env prod都合法,但后者要求env是布尔以外的类型(如 string),否则会被当开关处理 - 如果选项带等号(
=),值不能含空格;若要传带空格的字符串,必须用引号包裹,比如--message="hello world" - 未在
options()中声明的选项一律被拒绝,不会静默忽略
Yii2 控制台命令的 positional arguments 怎么获取
位置参数(即不带 -- 的裸字符串)默认按顺序映射到 actionXXX() 方法的参数上。比如定义 public function actionDeploy($host, $branch = 'main'),运行 yii deploy example.com develop 就会把 example.com 赋给 $host,develop 赋给 $branch。
但要注意:Yii2 不做参数个数校验。少传会导致 Missing argument PHP 致命错误;多传则多余部分被丢弃,且不报错。
- 所有位置参数都必须出现在选项之后,例如
yii migrate/create create_user_table --interactive=0合法,反过来就不行 - 如果动作方法参数有默认值,对应位置参数可省略;但一旦省略,后续带默认值的参数也必须全部省略(PHP 函数参数规则)
- 想动态读取全部位置参数?用
$this->getArgs(),它返回一个索引数组,绕过方法签名限制
为什么 --option 没生效,却提示 Unknown option
最常见原因是漏了 options() 声明,或拼写不一致。比如你在命令行写 --dry-run,但在 options() 里只写了 'dryrun' —— Yii2 不自动转换短横线,必须完全匹配。
- 选项名区分大小写:
'Env'≠'env' - 别在
options()里写--env,只写'env';加--是调用时的事 - 继承自
Controller的子类,如果重写了options()却没调用parent::options($id),会丢失父类自带选项(如help) - 某些第三方扩展可能覆盖了选项解析逻辑,检查是否引入了自定义
OptionParser
混合使用 --option 和 arguments 时的典型陷阱
当两者混用,顺序和语义容易出错。Yii2 解析器严格遵循 “选项优先、位置参数收尾” 规则,但用户常误以为可以穿插。
例如 yii import users.csv --batch=100 --verbose users-backup.json 看似合理,实际 users-backup.json 会被当成 import 动作的位置参数,而 --batch 和 --verbose 才是选项 —— 这本身没错,但如果你的 actionImport() 只定义了一个 $file 参数,那 users-backup.json 就会覆盖 users.csv,因为后者被当成了第一个位置参数,前者是第二个,而方法只收一个。
- 位置参数永远从左到右依次绑定,不管前面有没有选项
- 没有“命名参数”概念,
--file=xxx是选项,xxx是位置参数,二者不互通 - 调试时可用
$this->stdout(print_r($this->getArgs(), true) . "\n");看实际捕获了哪些位置参数
最麻烦的是参数歧义:比如 -- 本身是 POSIX 终止选项解析的标记,但 Yii2 并不原生支持它。如果真要传以 -- 开头的值(如 --no-color),只能用 --option="--no-color" 这种方式,靠等号强制识别为值而非选项。
















