Magento 2 Code mit Live-Templates automatisch generieren

Mit Magento 2 muss man nicht nur viel über die neue Architektur lernen – man muss auch weiterhin viel Code schreiben. Die grundlegenden Bausteine der Module, der so genannte Boilerplate-Code, wollen immer wieder geschrieben werden. Das ist eine repetitive Tipp-Arbeit, die besonders dann viel Zeit in Anspruch nimmt, wenn man noch nicht lange mit einer Software arbeitet, wie es bei uns allen mit Magento 2 der Fall ist.

Die beliebte IDE PhpStorm und die Community erleichtern uns die Arbeit über Live-Templates.

PhpStorm-Live-Templates aus der Community

Bereits 2016 haben drei Community-Mitglieder Live-Templates veröffentlicht: Nathan McBride, Vinai Kopp und Peter Jaap. 2020 zog Mark Shust nach.

Liste von PhpStorm-Live-Templates für Magento 2
Liste von PhpStorm-Live-Templates für Magento 2

Nathans Live-Templates stellen unter anderem Dummy-Code bereit für den Controller, Block-Klassen, DI-Konfiguration, Layout-XML-Definitionen, Modul-Deklarations-Dateien, Routen-Definitionen, und Systemkonfigurations-Einträge. Für die Installation lädt man die .jar-Datei aus dem GitHub-Repository herunter und importiert sie über das PhpStorm-Menü „File | Import Settings“.

Vinais Live-Templates enthalten zum Teil Code-Snippets für dieselben Anwendungsfälle. Neu sind hier zum Beispiel die Registrierungs- und die Composer-Datei für Module. Vinais Templates kann man wie in der PhpStorm-Dokumentation beschrieben manuell einpflegen.

Dasselbe gilt für die Templates von Peter Jaap, welche die Anlage von Konsolen-Befehlen, Crontab-Einträgen und Themes erleichtern.

Schließlich erlauben die Templates von Mark Shust unter anderem, diverse XML-Files zu erstellen.

Anwendung von PhpStorm-Live-Templates

In allen Fällen erstellt man schließlich eine PHP-, XML- oder JSON-Datei in die der Magento-Code eingefügt werden soll, gibt die Abkürzung wie zum Beispiel „mcontroller“ ein und drückt die Tab-Taste oder Enter (je nach Einstellung), um das Kürzel durch den vollständigen Code ersetzen zu lassen. Nun kann man noch die Platzhalter ausfüllen und hat wieder ein wenig Zeit gespart.

Der vom Live-Template "mcontroller" erstellte Magento-2-Code.
Der vom Live-Template „mcontroller“ erstellte Magento-2-Code.