Magento 2-Ereignisliste und deren Verwendung

In diesem Beitrag zeigen wir Ihnen, wie Sie Ereignisse in Magento 2 verwenden. Aber zuerst müssen wir etwas über Ereignisse und Beobachter verstehen. Die Implementierung von Ereignissen und Beobachtern in Magento 2 basiert auf dem Publish-Subscribe-Muster. Mithilfe von Ereignissen und Beobachtern können Sie Ihren benutzerdefinierten Code als Reaktion auf ein bestimmtes Magento- Ereignis oder sogar ein benutzerdefiniertes Ereignis ausführen.

Was sind Veranstaltungen in Magento?

Ereignisse werden von Modulen ausgelöst, wenn bestimmte Aktionen ausgelöst werden. Zusätzlich zu seinen eigenen Ereignissen ermöglicht Ihnen Magento, Ihre eigenen Ereignisse zu erstellen, die in Ihrem Code versendet werden können. Wenn ein Ereignis gesendet wird, kann es Daten an alle Beobachter weitergeben, die für die Überwachung dieses Ereignisses konfiguriert sind.

Was sind Beobachter in Magento?

Beobachter sind eine bestimmte Art von Magento-Klasse, die das allgemeine Verhalten und die Leistung beeinflussen oder die Geschäftslogik ändern kann. Observer werden immer dann ausgeführt, wenn das Ereignis, für dessen Überwachung sie konfiguriert sind, vom Ereignismanager gesendet wird.

Nachdem wir die Terminologien verstanden haben, wenden wir sie an!

1. Erstellen Sie die event.xml-Datei

Sie können eine event.xml -Datei für verschiedene Bereiche erstellen:

• Globaler Bereich: app/code/Simi/HelloWorld/etc/events.xml
• Frontend-Bereich: app/code/Simi/HelloWorld/etc/frontend/events.xml
• Admin-Bereich: 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">
    <Ereignisname="my_module_event_before">
        <observer name="myObserverName" instance="MyCompany\MyModule\Observer\MyObserver" />
    </Ereignis>
    <Ereignisname="my_module_event_after">
        <observer name="myObserverName" instance="MyCompany\MyModule\Observer\AnotherObserver" />
    </Ereignis>
</config>

2. Erstellen Sie die Observer-Klasse

Um einen Beobachter zu erstellen, müssen Sie Ihre Klassendatei in Ihrem Verzeichnis <module-root>/Observer ablegen. Ihre Observer-Klasse sollte Magento\Framework\Event\ObserverInterface implementieren und ihre Ausführungsfunktion definieren.

Unten sehen Sie ein Beispiel für die grundlegende Struktur der Beobachterklasse:

 Namensraum MeineFirma\MeinModul\Beobachter;

Verwenden Sie Magento\Framework\Event\ObserverInterface;

Klasse MyObserver implementiert ObserverInterface
{
  öffentliche Funktion __construct()
  {
    // Beobachter-Initialisierungscode...
    // Sie können Abhängigkeitsinjektion verwenden, um jede Klasse zu erhalten, die dieser Beobachter benötigt.
  }

  öffentliche Funktion execute(\Magento\Framework\Event\Observer $observer)
  {
    // Beobachter-Ausführungscode...
  }
}

Eines der leistungsstarken Features von Beobachtern besteht darin, dass sie Parameter verwenden können, die an das Ereignis übergeben wurden, als es gesendet wurde.

Hier ist ein Beispiel für einen Beobachter, der Daten erhält, die beim Senden des Ereignisses übergeben wurden:

 Namensraum MeineFirma\MeinModul\Beobachter;

Verwenden Sie Magento\Framework\Event\ObserverInterface;

Klasse AnotherObserver implementiert ObserverInterface
{
  öffentliche Funktion __construct()
  {
    // Beobachter-Initialisierungscode...
    // Sie können Abhängigkeitsinjektion verwenden, um jede Klasse zu erhalten, die dieser Beobachter benötigt.
  }

  öffentliche Funktion execute(\Magento\Framework\Event\Observer $observer)
  {
    $myEventData = $observer->getData('myEventData');
    // Zusätzlicher Observer-Ausführungscode...
  }
}

Veranstaltungen abonnieren

Beobachter können so konfiguriert werden, dass sie bestimmte Ereignisse in der Datei events.xml beobachten.

Das XML-Element Observer hat die folgenden Eigenschaften:

• name (erforderlich) – Der Name des Beobachters für die Ereignisdefinition.
• instance (erforderlich) – Der vollständig qualifizierte Klassenname des Beobachters.
• disabled – Legt fest, ob dieser Beobachter aktiv ist oder nicht. Der Standardwert ist falsch.
• shared – Bestimmt den Lebensstil der Klasse. Standard ist wahr.

Nachfolgend finden Sie ein Beispiel dafür, wie Sie Beobachter zuweisen können, um bestimmte Ereignisse zu beobachten:

 <?xml-Version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
    <Ereignisname="my_module_event_before">
        <observer name="myObserverName" instance="MyCompany\MyModule\Observer\MyObserver" />
    </Ereignis>
    <Ereignisname="my_module_event_after">
        <observer name="myObserverName" instance="MyCompany\MyModule\Observer\AnotherObserver" />
    </Ereignis>
</config>

Beachten Sie, dass Beobachternamen pro Ereignisdefinition eindeutig sein müssen. Sie können nicht zwei Beobachter mit demselben Namen in derselben Ereignisdefinition haben, um eine Überschreibung zu vermeiden.

3. Dispatch-Ereignis

Ereignisse können mit der Klasse Magento\Framework\Event\Manager versendet werden. Diese Klasse kann durch Abhängigkeitsinjektion abgerufen werden, indem Sie die Abhängigkeit in Ihrem Konstruktor definieren.

Um ein Ereignis zu versenden, rufen Sie die Dispatch-Funktion der Event-Manager-Klasse auf und geben Sie den Namen des Ereignisses, das Sie versenden möchten, zusammen mit einem Array von Daten an, die Sie den Beobachtern zur Verfügung stellen möchten.

Das folgende Beispiel zeigt Ihnen, wie Sie ein Ereignis mit und ohne ein Array von Daten senden.

 Namensraum MeineFirma\MeinModul;

verwenden Sie Magento\Framework\Event\ManagerInterface als EventManager;

Klasse MeineKlasse
{
  /**
   * @var EventManager
   */
  privater $eventManager;

  öffentliche Funktion __construct(EventManager $eventManager)
  {
    $this->eventManager = $eventManager;
  }

  öffentliche Funktion etwas ()
  {
    $eventData = null;
    // Code...
    $this->eventManager->dispatch('my_module_event_before');
    // Weiterer Code, der $eventData setzt...
    $this->eventManager->dispatch('my_module_event_after', ['myEventData' => $eventData]);
  }
}

Magento 2-Ereignisliste

See also:

So aktivieren Sie den Entwicklermodus in Magento 2

So erhalten Sie die Produktbild-URL in Magento 2