Magento 2 Modulentwicklung – Teil 1: Vorbereitung

Unser neues Magento 2 Modul

Das neue Modul lässt sich am einfachsten direkt über Composer einrichten. Das Modul direkt im Shop zu entwickeln ist eher umständlich und wird nicht empfohlen.

Wir generieren also außerhalb des Shops ein neues Verzeichnis. In diesem Verzeichnis wird unser neues Modul liegen. Um das Modul nachher einfach mit Composer installieren zu können, sollte eine Versionsverwaltung benutzt werden. An dieser Stelle verwende ich dafür git.

Um unser Modul installieren zu können, müssen wir jetzt drei Dateien erstellen, die jedes Modul benötigt.

Als Erstes wird die composer.json angelegt:

{
  "name": "tudock/helloworld",
  "description": "Tutorial Modul für die Magento 2 Blogserie.",
  "require": {
    "magento/magento-composer-installer": "*"
  },
  "type": "magento2-module",
  "version": "0.0.1",
  "autoload": {
    "files": [ "registration.php" ],
      "psr-4": {
        "Tudock\\HelloWorld\\": ""
    }
  }
}

Diese Datei ist die Paketdatei für Composer. Unter „name“ befindet sich der Name des Paketes. Dieser besteht nur aus Kleinbuchstaben und hat das Format (package)/(modulname).

Unter „version“ können wir die aktuelle Version unseres Moduls eintragen. Wichtig zu wissen ist, dass diese Version für Magento selbst keine Bedeutung hat (auch nicht für Upgrade-Scripts). Composer verwendet sie allerdings um festzustellen, wann eine neue Version des Moduls verfügbar ist.

Der Eintrag unter „autoload“ teilt Composer mit, unser Modul unter „vendor/“ im Shop zu installieren. Es wird nicht nach app/code kopiert, sondern bleibt direkt unter vendor/tudock/helloworld, dort können wir damit entwickeln.

Als Nächstes braucht Magento eine PHP-Datei, um das Modul zu entdecken. Magento scannt den Shop an einigen Schlüsseldateien nach Scripts mit dem Namen registration.php. Diese Datei legen wir jetzt für unser Modul an:

<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
    <module name="Tudock_HelloWorld" setup_version="0.0.1" />
</config>

Wie man sieht, ist diese stark abgespeckt worden. Unter „name“ einfach wieder den Modulnamen eintragen. Unter „setup_version“ folgt dann noch einmal die Version des Moduls.

Tipp:

Magento 2 benutzt XML Schema Definitionen für die verschiedenen XML Dateien. Der Link zur Schema-Datei steht unter „xsi:noNamespaceSchemaLocation“.

Dieser Link wird von Magento aufgelöst und vom eigenen IDE meist nicht verstanden. Um für phpstorm eine Datei zu erstellen, die die Pfade auflöst, bringt Magento direkt einen Befehl mit:

cd 
bin/magento dev:urn-catalog:generate /.idea/misc.xml

Dieser Befehl speichert die Datei gleich am richtigen Ort für phpstorm. Support für weitere IDEs soll in Zukunft folgen.

Das Magento 2 Modul installieren

Unser kleines Demo-Modul ist jetzt schon bereit für die Installation. Um das Modul zu installieren, müssen wir die composer.json im Shop anpassen. Dafür „repositories“ um einen Eintrag erweitern:

    "repositories": [
        {
            "type": "composer",
            "url": "https://repo.magento.com/"
        },
        {
            "type": "vcs",
            "url": "/pfad/zum/Modul/"
        }
    ],

Wir tragen unser Paket als Composer Repository via Version Control System ein. So eingerichtet wird Composer mit jedem Commit eine neue Version des Moduls registrieren, das heißt, wir können mit jedem Commit updaten. Es ist auch möglich, Commits mit Versionen zu taggen. Wer mehr über das Zusammenspiel von Composer und git wissen möchte – eine Recherche zu diesem Thema ist lohnenswert.

Um unser Modul zum Shop hinzuzufügen, müssen wir jetzt folgende Befehle eingeben:

cd 
# Installiere das Modul via Composer
composer require tudock/helloworld @dev # Name des Paketes in der composer.json unseres Moduls
# @dev zwingt Composer das Modul zu installieren obwohl es als zu instabil eingestuft wird

# Aktiviere das Modul
bin/magento module:enable Tudock_HelloWorld

# Upgrade Magento (richte Datenbanken etc. ein)
bin/magento setup:upgrade