14.Magento 2 中如何添加控制台命令

Magento 2 开发目录

本文讨论如何添加控制台命令。Magento 2 使用命令行可以快速实现一些操作:

  • 安装 Magento (相关的还有创建、更新数据表,添加或发布配置文件等)
  • 清缓存
  • 管理索引,重建索引
  • 创建翻译文件及语言包
  • 生成不存在的一些类如工厂类和插件的拦截器,为对像管理器生成依赖注入配置文件
  • 发布静态文件
  • 编译LESS到CSS

开始之前确保 HelloWorld 模块还在,这个模块在前面章节也一直使用。下面开始添加我们自定义的命令:

第一步:在 di.xml 定义命令

在 di.xml 文件中可以使用 name 属性为 Magento\Framework\Console\CommandList 的 type 节点定义命令参数。

文件: app/code/Aqrun/HelloWorld/etc/di.xml

<type name="Magento\Framework\Console\CommandList">
    <arguments>
        <argument name="commands" xsi:type="array">
            <item name="exampleSayHello" xsi:type="object">Aqrun\HelloWorld\Console\Sayhello</item>
        </argument>
    </arguments>
</type>

代码中定义了一个命令类 Sayhello。命令类中会定义命令行名称,并实现 execute() 方法

第二步:创建命令类

根据配置文件我们创建如下类

文件: app/code/Aqrun/HelloWorld/Console/Sayhello.php

<?php
namespace Aqrun\HelloWorld\Console;

use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

class Sayhello extends Command
{
    protected function configure()
    {
        $this->setName('示例:sayhello');
        $this->setDiscription('示例命令');
        parent::configure();
    }

    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $output->writeln('你好世界');
    }
}

函数中实现了两个方法:

  • configure() 函数用来设置名称、描述、命令行参数
  • execute() 函数会在控制台调用命令时执行

类的定义完成后清空缓存,执行如下命令:

php magento list

可以输出所有可用命令,我们刚添加的自定义命令也在:

14-cli-list1.png

现在可以在控制台运行 php bin/magento example:sayhello

14-cli-list1-result.png

接下来可以给命令添加一些参数。

代码如下:

<?php
namespace Aqrun\HelloWorld\Console;

use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Input\InputOption;

class Sayhello extends Command
{

    const NAME = 'name';

    protected function configure()
    {
        $options = [
            new InputOption(self::NAME, null,InputOption::VALUE_REQUIRED, '姓名')
        ];

        $this->setName('example:sayhello')
            ->setDescription('示例命令')
            ->setDefinition($options);
        parent::configure();
    }

    protected function execute(InputInterface $input, OutputInterface $output)
    {
        if ($name = $input->getOption(self::NAME)) {
            $output->writeln('你好' . $name);
        } else {
            $output->writeln('你好世界');
        }
    }
}

代码中我们在 configure() 函数中定义了命令行参数 name,并在 execute() 方法中获取它的值。清空缓存然后运行 php bin/magento example:sayhello --name=Aqrun 就会输出 “你好Aqrun”。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,744评论 6 502
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,505评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 163,105评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,242评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,269评论 6 389
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,215评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,096评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,939评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,354评论 1 311
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,573评论 2 333
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,745评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,448评论 5 344
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,048评论 3 327
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,683评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,838评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,776评论 2 369
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,652评论 2 354

推荐阅读更多精彩内容