Üblicherweise speichert man Adobe Commerce Module im Verzeichnis app/code/<vendor>/. In diesem Blogpost zeige ich dir eine alternative Methode und erkläre Dir, warum du sie in Betracht ziehen solltest.

Bei run_as_root behandeln wir Custom-Module wie Composer-Packages.
Für jedes unserer Module erstellen wir ein eigenes Composer-Package, legen es im src/-Verzeichnis ab und binden es per Composer ein.

Wenn du wissen möchtest, wie man ein Modul zum Composer-Package macht, schau dir die Anleitung im Adobe Developer Portal an.

Der Hauptgrund dafür ist, Abhängigkeiten zwischen deinen Modulen mit Composer zu managen.

Ist es dir schon mal passiert, dass du ein Modul gelöscht hast, aber in einem anderen Modul immer noch eine Abhängigkeit drauf war? 😱

Die klassische bekannte Deklaration in module.xml hilft hier nicht weiter, denn das <sequence>-Tag steuert nur die Lade-Reihenfolge – es prüft nicht, ob ein Modul überhaupt existiert oder entfernt wurde.

Wie wir gesehen haben, funktioniert diese Methode zum Verwalten von Projekt-Abhängigkeiten nicht zuverlässig. Composer ist jedoch genau dafür gemacht – also warum nicht Composer das machen lassen?

Wie wir jetzt wissen, ist der einzige echte Weg, Abhängigkeiten deiner Custom-Module zu verwalten, Composer zu nutzen.
Dabei musst du sie sowohl in composer.json als auch in module.xml angeben:

So sieht’s in der composer.json aus:

 1{
 2  "name": "vendor/module-name",
 3  "description": "Beschreibung deines Moduls",
 4  "version": "1.0.0",
 5  "require": {
 6    "vendor/dependency-module": "^1.0"
 7  },
 8  "type": "magento2-module",
 9  "autoload": {
10    "files": [
11      "registration.php"
12    ],
13    "psr-4": {
14      "Vendor\\ModuleName\\": ""
15    }
16  }
17}

Und so in der module.xml:

1<?xml version="1.0"?>
2<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
3    <module name="Vendor_ModuleName">
4        <sequence>
5            <module name="Vendor_DependencyModule"/>
6        </sequence>
7    </module>
8</config>

Hast du alle Abhängigkeiten sauber deklariert, kannst du dich getrost zurücklehnen und Composer den Rest erledigen lassen.

Vergiss nicht, während der Modul-Entwicklung diesen Magento best practices zu folgen:

Und denk dran: Ein wichtiger Aspekt sauberer Architektur ist, Module möglichst ohne Abhängigkeiten zu entwickeln.

Kurz zusammengefasst: