Magento 2 开发内容目录

本文件讨论Magneto 2 事件列表。众所周知,Magento 2 主要使用事件驱动架构,非常便于扩展系统的核心功能。可以把事件看作在某种情况发生时抛出的信号旗。继续使用之前的 HelloWorld 模块演示本节代码。

内容目录:

触发事件

可以使用类 Magento\Framework\Event\Manager 触发事件。如下面这个控制器只是显示 “Hello World” 文字

文件: app/code/Aqrun/HelloWorld/Controller/Index/Text.php

namespace Aqrun\HelloWorld\Controller\Index;

class Text extends \Magento\Framework\App\Action\Action
{
    public function execute()
    {
        echo 'Hello World';
        exit;
    }
}

现在如果想触发一个事件可以让其它模块能够修改上面显示的文字内容。可以做如下修改:

namespace Aqrun\HelloWorld\Controller\Index;
class Text extends \Magento\Framework\App\Action\Action
{
    public function execute()
    {
        $textDisplay = new \Magento\Framework\DataObject(['text' => '修改前要显示的文字']);
        $this->_eventManager->dispatch('aqrun_helloworld_display_text', ['textDisplay' => $textDisplay]);
        echo $textDisplay->getText();
        exit;
    }
}

display() 方法接收两个参数:全局唯一的事件标识及一个数据数组。上面代码主要是把文字先变成对象形式传给事件,然后再从对象重新获取文字。

监听和处理事件

事件范围

Magento系统有范围的定义。分为前端范围和后台范围。对于配置文件就会有3个地方可以放:

因此事件配置文件就会有如下三种:

创建 events.xml

本例只是前端监听事件修改文字显示,所以 events.xml 文件在 etc/frontend/ 目录

文件: app/code/Aqrun/HelloWorld/etc/frontend/events.xml

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
    <event name="aqrun_helloworld_display_text">
        <observer name="mp_display_text" instance="Aqrun\HelloWorld\Observer\ChangeDisplayText" />
    </event>
</config>

上面代码中,config 节点下面定义了 event 节点,name 属性值是 dispatch 函数发送事件时的事件名称。observer 节点的 instance 属性指定这个事件由哪个类处理,observer 的 name 属性是为了区分当前事件的其它监听器的唯一标识。

监听器

现在添加监听器类来处理上面的事件

文件: app/code/Aqrun/HelloWorld/Observer/ChangeDislayText.php

<?php
namespace Aqrun\HelloWorld\Observer;

class ChangeDisplayText implements \Magento\Framework\Event\ObserverInterface
{
    public function execute(
        \Magento\Framework\Event\Observer $observer
    ){
        $textDisplay = $observer->getData('textDisplay');
        echo $textDisplay->getText() . " - 事件处理中 <br/>";
        $textDisplay->setText('事件处理成功,内容已经修改');

        return $this;
    }
}

这个类实现了 ObserverInterface 接口的 execute 方法。清除缓存后页面显示如下:

event result

查看系统所有事件列表

系统核心文件定义的事件可以使用编辑器(PHPSTORM等)的全文搜索功能查看,搜索关键字如下:

搜索后的源代码形如:

// php
$this->_eventManager->dispatch('sales_quote_remove_item', ['quote_item' => $item]);

//js 
varienGlobalEvents.fireEvent('gridRowClick', event);