Joomla! Documentation™

Tutorial - Wie eine lokale Entwicklungsumgebung für Joomla! 4 eingerichtet wird

Joomla! 

4.x

Mit Joomla! 4 wurde der Entwicklungsprozess verändert. Es ist nicht länger möglich, das Repository zu klonen und so Joomla! zu installieren. Im Folgenden ist nach aktuellen Erfahrungswerten ein funktionaler Weg zur Installation beschrieben.

Schnellstart-Anweisungen

Abhängig vom Betriebssystem unterscheidet sich die Einrichtung der Entwicklungsumgebung. Es ist leider nicht möglich, den Vorgang für die verschiedenen Betriebssysteme zu dokumentieren. Die bevorzugte Suchmaschine wird hier weiterhelfen.

Benötigte Werkzeuge

1. PHP - im Wesentlichen dasselbe wie beim Betreiben einer Joomla!-Seite, allerdings brauchst du eine spezielle Version, die PHP CLI (Kommandozeileneingabe) (beachte auch die Seite Einrichten eines LAMPP-Servers für die PHP-Entwicklung)
2. Composer - um die Abhängigkeiten von Joomla!s PHP zu verwalten. Hilfe bei der Installation von Composer bietet die Dokumentation auf https://getcomposer.org/doc/00-intro.md
3. Node.js - um JavaScript- und SASS-Dateien für Joomla! zu kompilieren - Hilfe bei der Installation von Node.js bieten die Anweisungen, die auf https://nodejs.org/en/ erhältlich sind. Hinweis: Für die Installation von Joomla wird mindestens NodeJS 12 benötigt.
4. Git - für die Versionsverwaltung.

Schritt für Schritt zur Installation der lokalen Entwicklungsumgebung

1. Das Repository klonen
2. Zum Branch 4.0-dev wechseln (checkout)
3. Die Installation von composer install im Stammverzeichnis des Git-Repositorys ausführen. (Man kann --ignore-platform-reqs hinzufügen, wenn man das PHP-LDAP nicht lokal installiert hat und es nicht benötigt.)
4. Im Stammverzeichnis des Git-Repositorys npm ci ausführen. (Bitte beachten, dass dafür npm 6.13.4 oder höher benötigt wird. Um die npm-Version auf die LTS-Version zu aktualisieren, sollte npm install -g npm@lts ausgeführt werden.)

Linux und OSX Benutzer können den folgenden Bash-Alias nutzen und ihn in der ~/.bashrc-Datei setzen:

alias jclean="rm -rf administrator/templates/atum/css; rm -rf templates/cassiopeia/css; rm -rf administrator/templates/system/css; rm -rf templates/system/css; rm -rf media/; rm -rf node_modules/; rm -rf libraries/vendor/;rm -f administrator/cache/autoload_psr4.php;rm -rf installation/template/css"
alias jinstall="jclean; composer install; npm ci"

Das wird alle kompilierten Dateien im System löschen und eine neue Installation über den Befehl jinstall innerhalb der Joomla-Installation starten. Man kann auch den Befehl jclean verwenden, um zu einem Joomla 3.x Branch zurückzuwechseln

Die etwas längere Startanleitung

Joomla! unterscheidet sich heutzutage nicht von anderen Internetwerkzeugen. Es weist einen großen PHP-Teil auf und erhält mehr und mehr JavaScript-Code. Während die Programmierung mit PHP nicht sehr viel Vorbereitung benötigt, braucht JavaScript eine umfangreiche Werkzeugumgebung. Der Hauptgrund liegt darin, dass niemand Programmkode auf eine Weise schreibt, die jeder Browser versteht, daher muss der Kode auch von zum Beispiel ES6 in eine kompatible Version von JavaScript transkompiliert werden. Dasselbe gilt für CSS: In Joomla! verwenden wir SASS, dieses wird in natives CSS konvertiert, sodass es jeder Browser verstehen kann. Die Kehrseite bei der Installation einer Entwicklerumgebung ist, dass es ein bisschen komplizierter ist, dafür die Werkzeugausstattung das Programmieren viel bequemer macht. Dank Wächtern und dem automatischen Browserreload werden Änderungen in Echtzeit angezeigt.

PHP

Es sollte reichen, composer install auszuführen. Dies wird die PHP-Abhängigkeiten, die in der Datei composer.lock gespeichert sind, installieren. Man kann dies beliebig oft wiederholen, es werden nur neue Pakete installiert, wenn die composer.lock Datei verändert wird. Bitte composer update nicht ausführen, da dadurch alle Pakete auf neuere Versionen und die composer.lock Datei aktualisiert werden.

Beachte: Eventuell muss composer install mit der Option --ignore-platform-reqs ausgeführt werden um Plattformanforderungen, die in Composer näher spezifiziert sind, zu ignorieren, dass heißt falls du die PHP LDAP Erweiterung nicht installiert hast.

Node/npm Skripte

Node.js wird mit einem Paketmanager names NPM (in gewisser Weise das Gleiche wie Composer) ausgeliefert. NPM hat einen run-Befehl und wir haben ein paar Skripte vorbereitet, die dir das Leben erleichtern. Man muss die Befehle im Stammverzeichnis des Repositorys ausführen, sobald man JS- oder SASS-Dateien geändert hat. Zuvor muss einmalig npm ci ausgeführt werden, um die Abhängigkeiten zu installieren.

npm run build:css

Kompiliert SASS Dateien nach CSS und erzeugt die komprimierten Dateien.

npm run build:js

Kompiliert und transkompiliert die JavaScript Dateien in das richtige Format und erzeugt verkleinerte Dateien.

npm run watch

Dieser Befehl entspricht dem Befehl build:js, erkennt jedoch Änderungen und erstellt automatisch aktualisierte Dateien im Medienverzeichnis. SASS-Dateien sind noch nicht enthalten.

npm run lint:js

Führt eine Syntaxprüfung in den JavaScript-Dateien aus.

npm run test

Dies wird andere JavaScript Testsuiten ausführen.

Mögliche Probleme

Beim Installieren des Composers kann es zu folgenden Fehlern kommen:

Problem 1
    - Installation request for joomla/ldap 2.0.0-beta -> satisfiable by joomla/ldap[2.0.0-beta].
    - joomla/ldap 2.0.0-beta requires ext-ldap * -> the requested PHP extension ldap is missing from your system.
Problem 2
    - Installation request for symfony/ldap v5.1.5 -> satisfiable by symfony/ldap[v5.1.5].
    - symfony/ldap v5.1.5 requires ext-ldap * -> the requested PHP extension ldap is missing from your system.

Die Lösung ist, die Composer-Installation mit der Option --ignore-platform-reqs auszuführen, um die in Composer angegebenen Plattformanforderungen zu ignorieren. Das heißt, wenn die LDAP-Erweiterung von PHP nicht installiert ist.

composer install --ignore-platform-reqs

Wenn ein Anmeldefehler, wie unten abgebildet, angezeigt wird, sollte die Datei library/autoload_psr4.php, wie im zweiten Bild gezeigt, gelöscht werden.