Magento2イベントリストとその使用方法

この投稿では、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 version = "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" />
    </ event>
    <event name = "my_module_event_after">
        <observer name = "myObserverName" instance = "MyCompany \ MyModule \ Observer \ AnotherObserver" />
    </ event>
</ config>

2.オブザーバークラスを作成します

オブザーバーを作成するには、クラスファイルを<module-root>/Observerディレクトリに配置する必要があります。 オブザーバークラスは、 Magento \ Framework \ Event \ ObserverInterfaceを実装し、その実行関数を定義する必要があります。

以下は、基本的なオブザーバークラス構造の例です。

 名前空間MyCompany\MyModule \ Observer;

Magento \ Framework \ Event\ObserverInterfaceを使用します;

クラスMyObserverはObserverInterfaceを実装します
{{
  パブリック関数__construct（）
  {{
    //オブザーバー初期化コード...
    //依存性注入を使用して、このオブザーバーが必要とする可能性のある任意のクラスを取得できます。
  }

  パブリック関数execute（\ Magento \ Framework \ Event \ Observer $observer）
  {{
    //オブザーバー実行コード...
  }
}

オブザーバーの強力な機能の1つは、イベントがディスパッチされたときにイベントに渡されたパラメーターを使用できることです。

これは、イベントがディスパッチされたときに渡されたデータを取得するオブザーバーの例です。

 名前空間MyCompany\MyModule \ Observer;

Magento \ Framework \ Event\ObserverInterfaceを使用します;

クラスAnotherObserverはObserverInterfaceを実装します
{{
  パブリック関数__construct（）
  {{
    //オブザーバー初期化コード...
    //依存性注入を使用して、このオブザーバーが必要とする可能性のある任意のクラスを取得できます。
  }

  パブリック関数execute（\ Magento \ Framework \ Event \ Observer $observer）
  {{
    $ myEventData = $observer-> getData（'myEventData'）;
    //追加のオブザーバー実行コード...
  }
}

イベントの購読

オブザーバーは、events.xmlファイル内の特定のイベントを監視するように構成できます。

オブザーバーxml要素には次のプロパティがあります。

• name （必須）–イベント定義のオブザーバーの名前。
• インスタンス（必須）–オブザーバーの完全修飾クラス名。
• 無効–このオブザーバーがアクティブかどうかを判別します。 デフォルト値はfalseです。
• 共有–クラスのライフスタイルを決定します。 デフォルトはtrueです。

以下は、特定のイベントを監視するようにオブザーバーを割り当てる方法の例です。

 <？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 = "my_module_event_before">
        <observer name = "myObserverName" instance = "MyCompany \ MyModule \ Observer \ MyObserver" />
    </ event>
    <event name = "my_module_event_after">
        <observer name = "myObserverName" instance = "MyCompany \ MyModule \ Observer \ AnotherObserver" />
    </ event>
</ config>

オブザーバー名は、イベント定義ごとに一意である必要があることに注意してください。 オーバーライドを回避するために、同じイベント定義に同じ名前の2つのオブザーバーを含めることはできません。

3.ディスパッチイベント

イベントは、 Magento \ Framework \ Event\Managerクラスを使用してディスパッチできます。 このクラスは、コンストラクターで依存関係を定義することにより、依存性注入によって取得できます。

イベントをディスパッチするには、イベントマネージャークラスのディスパッチ関数を呼び出し、ディスパッチするイベントの名前と、オブザーバーに提供するデータの配列を指定します。

次の例は、データの配列がある場合とない場合でイベントをディスパッチする方法を示しています。

 名前空間MyCompany\MyModule;

Magento \ Framework \ Event\ManagerInterfaceをEventManagerとして使用します。

クラスMyClass
{{
  / **
   * @var EventManager
   * /
  プライベート$eventManager;

  パブリック関数__construct（EventManager $ eventManager）
  {{
    $ this-> eventManager = $ eventManager;
  }

  パブリック関数something（）
  {{
    $ eventData = null;
    //コード...
    $ this-> eventManager-> dispatch（'my_module_event_before'）;
    // $eventData..を設定するその他のコード
    $ this-> eventManager-> dispatch（'my_module_event_after'、['myEventData' => $ eventData]）;
  }
}

Magento2イベントリスト

See also:

Magento2で開発者モードを有効にする方法

Magento2で製品画像のURLを取得する方法