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

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: