Shopware 5.3 Plugin 101 | Das Event-System

Hier möchte ich kurz auf die verschiedenen Events von Shopware eingehen und deren Funktionsweise kurz erklären…

Globale Events

Diese werden automatisiert von Shopware erstellt und wurden bereits kurz in Shopware Plugin 101 | Einfaches Plugin erstellen genutzt und erwähnt.

Bezieht sich dabei auf den Zeitpunkt nachdem die Controller Action der Artikel Detailseite ausgeführt wurde.

Das Event wird mit der getSubscribedEvents() Methode auf den jeweiligen Controller registriert (in unserem Fall der Artikel-Controller).

Jedes Post-Dispatch-Event beginnt mit:

Enlight_Controller_Action_PostDispatchSecure

lässt man die Definition am Ende weg, wird das Plugin nach jedem Seitenaufruf informiert. Was man tunlichst vermeiden sollte, daher hier eine Liste der verfügbaren Calls.

Shopware PostDispatch Event Liste

Man könnte auch ein komplettes Modul zum Listener hinzufügen, zum Beispiel mit Enlight_Controller_Action_PostDispatchSecure_Backend (anbei noch ein Teil der Backend Events)

Referenz zur Controller Action

Das ist alles schön und gut, aber woher bekommen wir jetzt die Informationen welche wir für das arbeiten mit den versch. Controllern brauchen?

Beim aufrufen der getSubscribedEvents Methode zeigen wir im unten stehenden Beispiel auf die Methode onFrontendDetail

 

Über die Enlight_Event_EventArgs erhalten wir ein Kontext-Objekt, welches Informationen über den Detail-Controller enthält.

Wir können zum Beispiel folgende Zugriffe tätigen

in den meisten Fällen benötigen wir View(), Response(), Request(). In unserem Fall nutzen wir nur den View() und assignen diesem dann am Ende noch den Namen eines Artikels mit

Application Events

Notify Events

Notify Events werden, wie der Name schon sagt, zur einfachen Benachrichtigung genutzt.

Wir loggen hier einfach das Event im Plugin Log, indem wir beim call der Methode ein Log Entry anlegen. Dazu holen wir uns erst den DI-Container (Shopware’s zentraler Dreh- und Angelpunkt) – getten uns den pluginlogger und schreiben eine Nachricht hinein.

Notify Until Events

Diese werden benutzt um gewisse Vorgänge abzubrechen in unserem Fall wenn ein Gutscheincode mit dem Wert „test“ in den Warenkorb gelegt wird

Dieser Event wurde manuell in sBasket.php gesetzt:

und gibt gewöhnlich false zurück.

Filter Events

Das Filter Event ist da um bestimmte Daten vor der Auslieferung im Frontend zu verändern. In unserem Fall nutzen wir das Paymentmeans-Filter Event

Vorher

Nachher

 

Collect Events

Diese Events werden eher selten genutzt. Besondere Fälle in denen diese Collect Events oft gebraucht werden ist die Suche und deren Facets (ProductNumberSearch.php) oder Less Files in Plugins (Compiler.php)

Mit diesem Collect Event können Plugins einfach mit Less Files erweitert werden.

Hier findet Ihr einige Beispiele für das Collect Event. Ich nutze zum Beispiel in einem Plugin das oben beschrieben Theme_Compiler_Collect_Plugin_Less Event.

MiHoEvents – ZIP File mit Collect Event Plugin Beispiel

 

 

 

2 Antworten auf „Shopware 5.3 Plugin 101 | Das Event-System“

  1. Super Erklärungen hier, tiptop.
    Wie hast du allerdings die Auflistung der Events bekommen?

    Ich steige da noch nicht so ganz hinter, wie ich eine Auflistung aller Events hole ggf. gegliedert nach listing, detail etc. sodass ich eben weiß, auf welche Events ich lauschen muss.

    Kannst du mir sagen, wie du die Event Liste angezeigt bekommen hast? 🙂

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.