Magento 2 事件列表以及如何使用它們

在這篇文章中，我們將向您展示如何在 Magento 2 中使用事件。但首先我們需要了解事件和觀察者。 Magento 2 中的事件和觀察者實現基於發布-訂閱模式。 使用事件和觀察者，您可以運行自定義代碼來響應特定的 Magento事件甚至自定義事件。

Magento 中的事件是什麼？

當觸發某些操作時，事件由模塊分派。 除了它自己的事件之外，Magento 還允許您創建可以在您的代碼中調度的自己的事件。 當一個事件被調度時，它可以將數據傳遞給任何被配置為觀察該事件的觀察者。

Magento 中的觀察者是什麼？

觀察者是某種類型的 Magento 類，可以影響一般行為、性能或更改業務邏輯。 每當事件管理器調度它們配置為觀察的事件時，就會執行觀察者。

現在我們了解了術語，讓我們將它們投入使用！

1.創建event.xml文件

您可以為不同的區域創建event.xml文件：

• 全局區： app/code/Simi/HelloWorld/etc/events.xml
• 前端區： app/code/Simi/HelloWorld/etc/frontend/events.xml
• 管理區： app/code/Simi/HelloWorld/etc/adminhtml/events.xml

 <?xml 版本="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
    <event name="my_module_event_before">
        <observer name="myObserverName" instance="MyCompany\MyModule\Observer\MyObserver" />
    </事件>
    <事件名稱="my_module_event_after">
        <observer name="myObserverName" instance="MyCompany\MyModule\Observer\AnotherObserver" />
    </事件>
</配置>

2.創建觀察者類

要創建觀察者，您必須將類文件放在<module-root>/Observer目錄下。 你的觀察者類應該實現Magento\Framework\Event\ObserverInterface並定義它的執行函數。

下面是一個基本的觀察者類結構的例子：

 命名空間 MyCompany\MyModule\Observer；

使用 Magento\Framework\Event\ObserverInterface；

MyObserver 類實現 ObserverInterface
{
  公共函數 __construct()
  {
    // 觀察者初始化代碼...
    // 你可以使用依賴注入來獲取這個觀察者可能需要的任何類。
  }

  公共函數執行（\Magento\Framework\Event\Observer $observer）
  {
    // 觀察者執行代碼...
  }
}

觀察者的強大功能之一是它們能夠在事件被調度時使用傳遞給事件的參數。

下面是一個觀察者獲取事件分發時傳入的數據的示例：

 命名空間 MyCompany\MyModule\Observer；

使用 Magento\Framework\Event\ObserverInterface；

類 AnotherObserver 實現 ObserverInterface
{
  公共函數 __construct()
  {
    // 觀察者初始化代碼...
    // 你可以使用依賴注入來獲取這個觀察者可能需要的任何類。
  }

  公共函數執行（\Magento\Framework\Event\Observer $observer）
  {
    $myEventData = $observer->getData('myEventData');
    // 額外的觀察者執行代碼...
  }
}

訂閱事件

可以將觀察者配置為觀察 eve​​nts.xml 文件中的某些事件。

觀察者 xml 元素具有以下屬性：

• name (required) -- 事件定義的觀察者的名字。
• instance (required) -- 觀察者的完全限定類名。
• disabled - 確定此觀察者是否處於活動狀態。 默認值為假。
• shared – 決定班級的生活方式。 默認為真。

下面是一個如何分配觀察者來觀察某些事件的例子：

 <?xml 版本="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
    <event name="my_module_event_before">
        <observer name="myObserverName" instance="MyCompany\MyModule\Observer\MyObserver" />
    </事件>
    <事件名稱="my_module_event_after">
        <observer name="myObserverName" instance="MyCompany\MyModule\Observer\AnotherObserver" />
    </事件>
</配置>

請注意，每個事件定義的觀察者名稱必須是唯一的。 在同一個事件定義中不能有兩個同名的觀察者以避免覆蓋。

3.調度事件

可以使用Magento\Framework\Event\Manager類調度事件。 這個類可以通過在你的構造函數中定義依賴來通過依賴注入獲得。

要分派事件，請調用事件管理器類的分派函數，並為它提供您要分派的事件的名稱以及您希望提供給觀察者的數據數組。

以下示例向您展示瞭如何分派帶有和不帶有數據數組的事件。

 命名空間 MyCompany\MyModule;

使用 Magento\Framework\Event\ManagerInterface 作為 EventManager；

我的班級
{
  /**
   * @var 事件管理器
   */
  私人 $eventManager;

  公共函數 __construct(EventManager $eventManager)
  {
    $this->eventManager = $eventManager;
  }

  公共功能某事（）
  {
    $事件數據=空；
    // 代碼...
    $this->eventManager->dispatch('my_module_event_before');
    // 更多設置 $eventData 的代碼...
    $this->eventManager->dispatch('my_module_event_after', ['myEventData' => $eventData]);
  }
}

Magento 2 事件列表

See also:

如何在 Magento 2 中啟用開發者模式

如何在 Magento 2 中獲取產品圖片 URL