Magento 2 Modulentwicklung - Teil 7: Observer, Helper und Fazit

Willkommen beim letzten Teil unserer Magento 2 Blogserie. In diesem Teil werden wir unser Demo-Modul durch einen Observer und einen Helper abrunden.

Observer

Ein Observer wird ausgeführt, wenn ein Event getriggert wird. Um einen Observer in Magento 2 zu erstellen, legen wir zunächst eine Klasse im Ordner Observer an. In unserem Beispiel erstellen wir die Datei Observer/ProductLoadInjecter.php:

<?php
namespace Tudock\HelloWorld\Observer;
use Magento\Framework\Event\Observer;

class ProductLoadInjecter implements \Magento\Framework\Event\ObserverInterface {

	public function execute(\Magento\Framework\Event\Observer $observer) {
		$model = $observer->getData('data_object');
		$model->setData('tudock_helloworld','Hello Observer!');
	}
}

Ein Observer implementiert das Interface \Magento\Framework\Event\ObserverInterface, welches wiederum die Methode execute hat. Diese Methode bekommt als Argument ein Objekt, in dem der Kontext des Events gespeichert ist. Mit getData können Event-spezifische Informationen aus dem Observer extrahiert werden.

Unser Beispiel-Observer wird sich an das Event catalog_product_load_after hängen, wird also ausgeführt nachdem ein Produkt geladen wurde.

In data_object befindet sich für dieses Event das Product-Model. An diesem Produkt-Model setzen wir beispielhaft den Wert tudock_helloworld auf einen Text, den wir nachher zum Testen auslesen werden.

Observer registrieren

Damit unser Observer auch ausgeführt wird, müssen wir ihn für das Event registrieren. Je nachdem ob wir wollen, dass unser Observer im Frontend- oder im Backend-Kontext ausgeführt wird, erstellen wir dafür eine Datei events.xml unter etc/frontend oder etc/adminhtml. Wir legen für unser Beispiel die Datei unter app/etc/frontend/events.xml an:

<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
    <event name="catalog_product_load_after">
        <observer name="helloworld_inject" instance="Tudock\HelloWorld\Observer\ProductLoadInjecter" shared="false" />
    </event>
</config>

Diese XML-Datei enthält event Knoten. Der name der Knoten gibt an, bei welchem Event unser Observer ausgeführt wird.

Innerhalb des event Knoten folgen beliebig viele observer Knoten, welche die Observer für das Event definieren. Jeder Observer braucht zumindest einen beliebigen name und die Klasse (instance), die unseren Observer repräsentiert.

Unseren Observer testen

Um den Observer zu testen, lassen wir uns das Datenfeld tudock_helloworld, das wir an jedes Produkt anhängen, in unserem HelloProduct Block ausgeben.

Dafür definieren wir zunächst eine neue Methode im HelloProduct Block:


	public function getObserverText() {
		return $this->getProduct()->getData('tudock_helloworld');
	}

Danach können wir im Template diesen Text ausgeben:

<p><?php echo $block->getObserverText(); ?></p>

Helper

Helper sind einfache Singleton-Klassen, die häufig verwendete (Hilfs-)Funktionen auslagern. Helper werden im Ordner Helper angelegt und können beliebig benannt werden. In Anlehnung an den Standard-Helper in Magento 1 heißt der Helper in diesem Modul Data, aber es kann beliebig viele Helper mit beliebigen Namen geben. Der Helper liegt unter Helper/Data.php:

<?php
namespace Tudock\HelloWorld\Helper;

class Data extends \Magento\Framework\App\Helper\AbstractHelper {
	public function getSomeColor() {
		return 'rgb('.rand(0,255).','.rand(0,255).','.rand(0,255).')';
	}
}

Jeder Helper sollte (muss aber nicht) \Magento\Framework\App\Helper\AbstractHelper erweitern. Unser Beispiel-Helper hat eine Methode, die eine zufällige CSS Farbe generiert.

Helper einbinden

Um einen Helper einzubinden, wird dieser einfach (ohne Factory, da Singleton) per Dependency Injection in eine Klasse geladen. In unserem Beispiel laden wir den Helper in den HelloProduct Block:

             /* … */
	protected $_dataHelper;

	public function __construct(
		\Magento\Catalog\Block\Product\Context $context,
		\Magento\Framework\Stdlib\ArrayUtils $arrayUtils,
		array $data,
		\Tudock\HelloWorld\Model\ResourceModel\HelloText\CollectionFactory $helloTextCollectionFactory,
		\Tudock\HelloWorld\Helper\Data $dataHelper
	) {
		parent::__construct($context, $arrayUtils, $data);
		$this->_helloTextCollectionFactory = $helloTextCollectionFactory;
		$this->_dataHelper = $dataHelper;
	}
             /* … */

Wir können den Helper jetzt benutzen, wie wir wollen. Für unsere Zwecke legen wir in der Klasse eine neue Methode an:

public function getColor() {
	return $this->_dataHelper->getSomeColor();
}

In diesem Beispiel leiten wir die Anfrage für eine Farbe an unseren Helper weiter, welcher eine zufällige CSS-Farbe generieren kann. Diese Farbe können wir nun im Template verwenden.

Unser Template sieht nach allen Änderungen ungefähr so aus:

<p style="color:<?php echo $block->getColor() ?>">
	<?php echo __('Hello') ?> , <?php echo $block->getProductName(); ?>!
</p>
<p>
	<a href="<?php echo $block->getHelloWorldUrl() ?>">
		<?php echo $block->getText() ?>
	</a>
</p>
<p style="color:<?php echo $block->getColor() ?>">
	<?php echo $block->getObserverText(); ?>
</p>

Wenn alles geklappt hat, sollte der Block auf der ADS nun ungefähr so erscheinen:

Magento 2 Helper Beispiel - Farbanzeige auf der ADS im Frontend

Mein Fazit zur Magento 2 Modulentwicklung

Mit Magento 2 hat sich so einiges geändert. Es gibt aktuell noch viele Probleme (auf Github allein gibt es über 1000 Issues), aber es hat sich auch einiges verbessert:

Die Modulentwicklung ist nun weitaus klarer gekapselt und Module sind viel weniger voneinander abhängig, dank Dependency Injection und Service Layer. Auch die ganze Modulverwaltung hat sich durch Composer endlich stark vereinfacht. Das XML-Chaos ist vorbei. Statt wie in Magento 1 alle möglichen Angaben doppelt und dreifach in einer großen XML Datei zu machen zu müssen, erkennt Magento 2 viele Dinge auf Anhieb.

Aber besonders im Frontend-Workflow (auf den ich in dieser Serie nur am Rande eingegangen bin) gibt es noch einiges an Nachholbedarf und einige Probleme, die das Arbeiten mit Magento 2 derzeit noch sehr stark erschweren.

Viele Themen habe ich hier noch nicht angesprochen (Plugins/Preferences, LESS, Javascript, Cronjobs etc.) – also wenn ihr ein Thema besonders interessant findet, lasst es uns wissen! Wir werden uns bemühen, eure Vorschläge in weiteren Artikeln aufzugreifen.

Aber fürs Erste ist diese Blogserie nun vorbei. Nichstdestotrotz laden wir euch ein, mit uns im Austausch zu bleiben. Die Kommentarfunktion unter diesem Blogbeitrag bietet eine gute Gelegenheit, um Fragen zu stellen und Antworten zu erhalten oder Anregungen für weitere Artikel zum Thema Magento 2 zu platzieren. Wir freuen uns auf euer Feedback!

Und zum Schluss noch einmal der Hinweis, dass das gesamte Demo-Modul auch auf Github verfügbar ist.

Autor: Kategorie: E-Commerce
Schlagwörter: Magento2, Wissen
YTo2OntzOjY6ImZldXNlciI7aTowO3M6MzoicGlkIjtpOjk2O3M6MzoiY2lkIjtpOjEwOTYxMjQyNTU7czo0OiJjb25mIjthOjEwOntzOjEwOiJzdG9yYWdlUGlkIjtpOjEyNDtzOjE0OiJleHRlcm5hbFByZWZpeCI7czoxMToidHhfbmV3c19waTEiO3M6MTM6IlVzZXJJbWFnZVNpemUiO2k6MTg7czo5OiJhZHZhbmNlZC4iO2E6MTp7czoyMToic2hvd0NvdW50Q29tbWVudFZpZXdzIjtpOjA7fXM6ODoic2hhcmluZy4iO2E6MTp7czoxMjoidXNlU2hhcmVJY29uIjtOO31zOjg6InJhdGluZ3MuIjthOjM6e3M6MTY6InJhdGluZ0ltYWdlV2lkdGgiO2k6MTE7czoxNjoicmV2aWV3SW1hZ2VXaWR0aCI7aToxNjtzOjg6Im1vZGVwbHVzIjtzOjQ6ImF1dG8iO31zOjY6InRoZW1lLiI7YTo3OntzOjI2OiJib3htb2RlbFRleHRhcmVhTGluZUhlaWdodCI7aTozMDtzOjI0OiJib3htb2RlbFRleHRhcmVhTmJyTGluZXMiO2k6NDtzOjE1OiJib3htb2RlbFNwYWNpbmciO2k6MTA7czoxODoiYm94bW9kZWxMaW5lSGVpZ2h0IjtpOjIwO3M6MTg6ImJveG1vZGVsTGFiZWxXaWR0aCI7aToxMzQ7czoyNjoiYm94bW9kZWxMYWJlbElucHV0UHJlc2VydmUiO2k6MTtzOjIyOiJib3htb2RlbElucHV0RmllbGRTaXplIjtpOjM1O31zOjE3OiJwcmVmaXhUb1RhYmxlTWFwLiI7YToxMDp7czoxNDoidHhfYWxidW0zeF9waTEiO3M6MTc6InR4X2FsYnVtM3hfaW1hZ2VzIjtzOjE1OiJ0eF9jb21tZXJjZV9waTEiO3M6MjA6InR4X2NvbW1lcmNlX3Byb2R1Y3RzIjtzOjEyOiJ0eF9pcmZhcV9waTEiO3M6MTA6InR4X2lyZmFxX3EiO3M6MTU6InR4X21pbmluZXdzX3BpMSI7czoxNjoidHhfbWluaW5ld3NfbmV3cyI7czo5OiJ0eF90dG5ld3MiO3M6NzoidHRfbmV3cyI7czoxMToidHRfcHJvZHVjdHMiO3M6MTE6InR0X3Byb2R1Y3RzIjtzOjI0OiJ0eF93ZWNzdGFmZmRpcmVjdG9yeV9waTEiO3M6MjU6InR4X3dlY3N0YWZmZGlyZWN0b3J5X2luZm8iO3M6MTI6InR4X2NvbW11bml0eSI7czo4OiJmZV91c2VycyI7czoxOToidHhfY3d0Y29tbXVuaXR5X3BpMSI7czo4OiJmZV91c2VycyI7czoxMToidHhfbmV3c19waTEiO3M6MjU6InR4X25ld3NfZG9tYWluX21vZGVsX25ld3MiO31zOjExOiJzaG93VWlkTWFwLiI7YTo1OntzOjk6InR4X3R0bmV3cyI7czo3OiJ0dF9uZXdzIjtzOjExOiJ0dF9wcm9kdWN0cyI7czo3OiJwcm9kdWN0IjtzOjEyOiJ0eF9jb21tdW5pdHkiO3M6NDoidXNlciI7czoxOToidHhfY3d0Y29tbXVuaXR5X3BpMSI7czoyNToiYWN0aW9uPWdldHZpZXdwcm9maWxlJnVpZCI7czoxMToidHhfbmV3c19waTEiO3M6NDoibmV3cyI7fXM6MTI6IlJlcXVpcmVkTWFyayI7czoxOiIqIjt9czo0OiJsYW5nIjtzOjI6ImRlIjtzOjM6InJlZiI7czoyOToidHhfbmV3c19kb21haW5fbW9kZWxfbmV3c18yNTUiO30%3DYTo0OntzOjQ6ImNvbmYiO2E6MzU6e3M6MTc6InVzZVdlYnBhZ2VQcmV2aWV3IjtzOjE6IjEiO3M6MjI6InVzZVdlYnBhZ2VWaWRlb1ByZXZpZXciO3M6MToiMSI7czoyMDoid2VicGFnZVByZXZpZXdIZWlnaHQiO3M6MjoiNzAiO3M6MjA6Im1heENoYXJzUHJldmlld1RpdGxlIjtzOjI6IjcwIjtzOjMxOiJ3ZWJwYWdlUHJldmlld0Rlc2NyaXB0aW9uTGVuZ3RoIjtzOjM6IjE2MCI7czozODoid2VicGFnZVByZXZpZXdEZXNjcmlwdGlvbk1pbmltYWxMZW5ndGgiO3M6MjoiNjAiO3M6Mjc6IndlYnBhZ2VQcmV2aWV3Q2FjaGVUaW1lUGFnZSI7czozOiIxODAiO3M6MzM6IndlYnBhZ2VQcmV2aWV3Q2FjaGVUaW1lVGVtcEltYWdlcyI7czoyOiI2MCI7czozMDoid2VicGFnZVByZXZpZXdDYWNoZUNsZWFyTWFudWFsIjtzOjE6IjAiO3M6Mjg6IndlYnBhZ2VQcmV2aWV3TnVtYmVyT2ZJbWFnZXMiO3M6MjoiMTAiO3M6Mzg6IndlYnBhZ2VQcmV2aWV3U2Nhbk1pbmltYWxJbWFnZUZpbGVTaXplIjtzOjQ6IjE1MDAiO3M6MzA6IndlYnBhZ2VQcmV2aWV3U2Nhbk1pbkltYWdlU2l6ZSI7czoyOiI0MCI7czozMDoid2VicGFnZVByZXZpZXdTY2FuTWF4SW1hZ2VTaXplIjtzOjM6IjQ1MCI7czoyOToid2VicGFnZVByZXZpZXdTY2FuTWluTG9nb1NpemUiO3M6MjoiMzAiO3M6MzE6IndlYnBhZ2VQcmV2aWV3U2Nhbk1heEltYWdlU2NhbnMiO3M6MjoiNDAiO3M6Mzg6IndlYnBhZ2VQcmV2aWV3U2Nhbk1heEltYWdlU2NhbnNGb3JMb2dvIjtzOjI6IjU1IjtzOjQwOiJ3ZWJwYWdlUHJldmlld1NjYW5NYXhIb3J6aXpvbnRhbFJlbGF0aW9uIjtzOjI6IjU7IjtzOjM3OiJ3ZWJwYWdlUHJldmlld1NjYW5tYXh2ZXJ0aWNhbHJlbGF0aW9uIjtzOjE6IjMiO3M6MzA6IndlYnBhZ2VQcmV2aWV3U2NhbkxvZ29QYXR0ZXJucyI7czoxMDoibG9nbyxjcmdodCI7czozODoid2VicGFnZVByZXZpZXdTY2FuRXhjbHVkZUltYWdlUGF0dGVybnMiO3M6NTc6InBpeGVsdHJhbnMsc3BhY2VyLHlvdXR1YmUscmNsb2dvcyx3aGl0ZSx0cmFuc3BhLGJnX3RlYXNlciI7czozODoid2VicGFnZVByZXZpZXdEZXNjcmlwdGlvblBvcnRpb25MZW5ndGgiO3M6MjoiNDAiO3M6MjU6IndlYnBhZ2VQcmV2aWV3Q3VybFRpbWVvdXQiO3M6NDoiNzAwMCI7czoxMjoidXNlUGljVXBsb2FkIjtzOjE6IjAiO3M6MTI6InVzZVBkZlVwbG9hZCI7czoxOiIwIjtzOjEzOiJwaWNVcGxvYWREaW1zIjtzOjM6IjEwMCI7czoxNjoicGljVXBsb2FkTWF4RGltWCI7czozOiI4MDAiO3M6MTY6InBpY1VwbG9hZE1heERpbVkiO3M6MzoiOTAwIjtzOjIyOiJwaWNVcGxvYWRNYXhEaW1XZWJwYWdlIjtzOjM6IjQ3MCI7czoyMzoicGljVXBsb2FkTWF4RGltWVdlYnBhZ2UiO3M6MzoiMzAwIjtzOjIwOiJwaWNVcGxvYWRNYXhmaWxlc2l6ZSI7czo0OiIyNTAwIjtzOjIwOiJwZGZVcGxvYWRNYXhmaWxlc2l6ZSI7czo0OiIzMDAwIjtzOjE4OiJzb3VuZGNsb3VkQ2xpZW50SUQiO3M6MDoiIjtzOjIyOiJzb3VuZGNsb3VkQ2xpZW50U2VjcmV0IjtzOjA6IiI7czoyMDoidXNlVG9wV2VicGFnZVByZXZpZXciO3M6MDoiIjtzOjI0OiJ0b3BXZWJwYWdlUHJldmlld1BpY3R1cmUiO2k6MDt9czoxMToiYXdhaXRnb29nbGUiO3M6Mjg6IldhcnRlIGF1ZiBBbnR3b3J0IHZvbiBHb29nbGUiO3M6ODoidHh0aW1hZ2UiO3M6MTM6IkJpbGQgZ2VmdW5kZW4iO3M6OToidHh0aW1hZ2VzIjtzOjE1OiJCaWxkZXIgZ2VmdW5kZW4iO30%3DYTowOnt9YTowOnt9YTo3OntzOjE2OiJjb21tZW50TGlzdEluZGV4IjthOjE6e3M6MzI6ImNpZHR4X25ld3NfZG9tYWluX21vZGVsX25ld3NfMjU1IjthOjE6e3M6MTA6InN0YXJ0SW5kZXgiO2k6MTU7fX1zOjE0OiJjb21tZW50c1BhZ2VJZCI7aTo5NjtzOjE2OiJjb21tZW50TGlzdENvdW50IjtpOjEwOTYxMjQyNTU7czoxMjoiYWN0aXZlbGFuZ2lkIjtpOjA7czoxNzoiY29tbWVudExpc3RSZWNvcmQiO3M6Mjk6InR4X25ld3NfZG9tYWluX21vZGVsX25ld3NfMjU1IjtzOjEyOiJmaW5kYW5jaG9yb2siO3M6MToiMCI7czoxMjoibmV3Y29tbWVudGlkIjtOO30%3D YTo1OntzOjExOiJleHRlcm5hbFVpZCI7aToyNTU7czoxMjoic2hvd1VpZFBhcmFtIjtzOjQ6Im5ld3MiO3M6MTY6ImZvcmVpZ25UYWJsZU5hbWUiO3M6MjU6InR4X25ld3NfZG9tYWluX21vZGVsX25ld3MiO3M6NToid2hlcmUiO3M6MTcwOiJhcHByb3ZlZD0xIEFORCBleHRlcm5hbF9yZWY9J3R4X25ld3NfZG9tYWluX21vZGVsX25ld3NfMjU1JyBBTkQgcGlkPTEyNCBBTkQgdHhfdG9jdG9jX2NvbW1lbnRzX2NvbW1lbnRzLmRlbGV0ZWQ9MCBBTkQgdHhfdG9jdG9jX2NvbW1lbnRzX2NvbW1lbnRzLmhpZGRlbj0wIEFORCBwYXJlbnR1aWQ9MCI7czoxMDoid2hlcmVfZHBjayI7czoxMzk6ImV4dGVybmFsX3JlZj0ndHhfbmV3c19kb21haW5fbW9kZWxfbmV3c18yNTUnIEFORCBwaWQ9MTI0IEFORCB0eF90b2N0b2NfY29tbWVudHNfY29tbWVudHMuZGVsZXRlZD0wIEFORCB0eF90b2N0b2NfY29tbWVudHNfY29tbWVudHMuaGlkZGVuPTAiO30%3D YToyOntpOjA7czoxNDk6IjxpbWcgc3JjPSIvdHlwbzNjb25mL2V4dC90b2N0b2NfY29tbWVudHMvcmVzL2Nzcy90aGVtZXMvdHVkb2NrL2ltZy9wcm9maWxlLnBuZyIgY2xhc3M9InR4LXRjLXVzZXJwaWMgdHgtdGMtdWltZ3NpemUiIHRpdGxlPSIiICBpZD0idHgtdGMtY3RzLWltZy0iIC8%2BIjtpOjk5OTk5O3M6MTUxOiI8aW1nIHNyYz0iL3R5cG8zY29uZi9leHQvdG9jdG9jX2NvbW1lbnRzL3Jlcy9jc3MvdGhlbWVzL3R1ZG9jay9pbWcvcHJvZmlsZWYucG5nIiBjbGFzcz0idHgtdGMtdXNlcnBpY2YgdHgtdGMtdWltZ3NpemUiIHRpdGxlPSIiICBpZD0idHgtdGMtY3RzLWltZy0iIC8%2BIjt9
Bitte bestätigen Sie
Nein
Ja
Information
Ok
Vorschau wird geladen ...
* Pflichtfeld
Ihr Kommentar ist eine Antwort auf den folgenden Kommentar

Wir behalten uns vor, Kommentare zu löschen, beispielsweise wenn sich diese nicht auf den Beitrag beziehen, zur Eigenwerbung missbraucht werden, persönliche Daten anderer enthalten, diskriminieren, beleidigen oder Rechte verletzen.

Datenschutzhinweis: Wenn Sie einen Kommentar oder sonstigen Beitrag in unserem Blog hinterlassen, speichern wir neben Ihren Angaben Ihre IP-Adresse. Darüber hinaus können Sie die Beiträge und Kommentare unseres Blogs abonnieren. Das Kommentarabonnement können Sie jederzeit abbestellen. Weitere Informationen finden Sie in unserer Datenschutzerklärung.

E-Commerce & Webentwicklung: Wir realisieren und optimieren Internetprojekte. Unser Fachgebiet sind Onlineshops, Rich Internet Applications und anspruchsvolle Onlineauftritte. Über unsere Arbeit schreiben wir. Hier im Blog von TUDOCK.