命令命名准则

命名规则概述

Magento 2引入了一个新的命令行接口（CLI），使组件开发者提供模块的命令。

作为一个扩展的开发者，你现在可以创建和分发自己的Magento应用命令。但对于任何实现，遵循一些一般约定来保持您的命令与其他开发人员的命令保持一致也是很重要的。以这种方式保持一致降低了用户的学习难度。

本主题讨论我们推荐的命名约定。

命令名称

命令名称是命令的一部分, 它定义了命令的行为。在命令中，它会在命令名之后。例如, 在 bin/magento setup:upgrade, bin/magento 是命令名和setup:upgrade 是命令的名称。

如果你有一个Magento 2命令界面，输入以下命令来显示当前列表

PHP <Magento 2 安装目录>/bin/magento --list

格式: `group:[subject:]action`

group

group 表示一组相关命令。列表中的组显示中的命令，这反过来又使用户更容易地找到所需的命令。要为命令找到一个组名称，请想象一个可以使用的主题区域。主题区域可以是以下任何一个:

DOMain 区域 (例如, module )
Workflow 区域 (例如, admin )

subject

subject 是行动的主体。这个主题是可选的，但对于定义同一个对象的命令集可能是有用的。如果主题是一个复合词的代表，用破折号或连字符分隔的话。

action

action 是命令的动作.

例如

// 一般命令：只是一组和一个动作
magento setup:install
magento module:status

// 带有主题的命令集
magento setup:config:set
magento setup:config:delete
magento setup:db-schema:upgrade
magento setup:db-data:upgrade

db-schema 和 db-data 是复合词的例子.

命令选项和参数

选项和参数遵循命令名，并修改命令的行为。

命令参数

例子:

magento dev:theme:create frontend vendor themename

命令选项

例子,

magento dev:theme:create --parent=Magento/luma frontend arg1 arg2
magento dev:theme:create -p=Magento/luma frontend vendor themename
magento dev:theme:create --extend-from=Magento/luma frontend vendor themename
magento module:disable -f Magento_Cms

如何添加CLI命令

Magento2中文手册