Konsole

• Einführung
• Aufruf der Konsole
• Hilfe
• Anwendungsbeispiele
  • Passwort setzen
  • Datenbank Backup erzeugen/zurückspielen
  • Datenbank Schema als PHP exportieren
  • package:list
  • install:list
  • package:run-update-script
  • Core/AddOn/PlugIn Assets synchronisieren
• Entwicklung eigener Konsolen-Skripte
  • run.php
  • package.yml
• Integration der Konsole in Phpstorm
• Tipps
  • Autovervollständigung

Einführung

REDAXO liefert mehrere CLI ("Command-line interface")-Befehle und Dienstprogramme, die über die Konsole (console) ausgeführt werden können. Sie ermöglichen es u.a. REDAXO zu installieren, AddOns zu aktualisieren und den Entwicklungsprozess sowie Wartungsarbeiten zu beschleunigen. AddOns oder PlugIns können den Funktionsumfang der Konsole um weiteren Befehle erweitern.

Mögliche Einsatzzwecke:

• REDAXO Installation
• AddOn-Installation / Deinstallation
• Schnittstelle für erweitere/spezielle Funktionen/Vorgänge
• Automatisierung/Scripting von Abläufen mit Zugriff auf das System
• Umgebung um sehr aufwändige Prozesse wie Migrationen, Report-Generierung o.ä. ablaufen zu lassen, ohne Timeouts etc.
• Fernwartung des Systems
• automatisierte Veröffentlichungsprozesse der Entwicklungsstände von Websites (Deploy-Workflows)
• via AddOns erweiterbar (Befehle registrierbar, siehe untenstehendes Beispiel)

Im Rahmen einer REDAXOHour ist eine Videoeinführung entstanden, die viele Punkte dieses Kapitels erklärt.

Zum Video bei YouTube

Aufruf der Konsole

php redaxo/bin/console

oder

redaxo/bin/console

(Hierbei sollte die Datei console ausführbar sein)

Je nach System ist es ggf. erforderlich, die Konsole unter dem PHP-User bzw. Eigentümer des Webordners auszuführen. In diesem Fall lautet der Befehl:

sudo -u username php redaxo/bin/console

Für Docker exec sollte man -u username an den Befehl anfügen.

Hilfe

Der einfache Aufruf der Konsole per console ohne Parameter liefert eine Liste aller aktuell verfügbaren Konsolen-Befehle.

Um mehr Informationen und Optionen zum jeweiligen Befehl zu erhalten, fügt man dem Aufruf des Kommandos --help als Parameter an.

z. B.: console cache:clear --help

Anwendungsbeispiele

Passwort setzen

Durch den Zugriff via REDAXO Konsole können für Backend-Benutzer neue Passwörter gesetzt werden. Dies ist insbesondere dann hilfreich, wenn kein Admin-Zugriff via Backend mehr möglich ist.

php redaxo/bin/console user:set-password <username> <passwort>

Datenbank Backup erzeugen/zurückspielen

Da in der Konsole in der Regel weniger Restriktionen gegeben sind, können umfangreiche Datenbanksicherungen erstellt oder wiederhergestellt werden. Speziell für große Datenbanken ist dies ein effizienter Weg zur Sicherung.

Erzeugt eine Sicherung in der Datei dump.sql

php redaxo/bin/console db:connection-options | xargs mysqldump > dump.sql

Wiedereinspielen einer vorher erstellten Sicherung aus der Datei dump.sql. In der Datenbank enthaltene Tabellen und Daten werden dabei überschrieben!

php redaxo/bin/console db:connection-options | xargs sh -c 'mysql "$0" "$@" < dump.sql'

Core/AddOn/PlugIn Assets synchronisieren

Um die Entwicklung von AddOns und PlugIns zu erleichtern, ist es möglich Dateien zwischen dem öffentlich zugänglichen assets/ Ordner und den AddOn/PlugIn Quellen unter redaxo/src/addons zu synchronisieren. Derzeit ist keine Enschränkung auf einzelne Ordner vorgesehen.

Die Synchronisierung erfolgt in der Reihenfolge:

1. Synchronisierung

Existiert die Datei/Verzeichnis nur in assets/ oder ist neuer als in redaxo/src/core/ bzw. redaxo/src/addons/ wird alles von assets/ nach redaxo/src/core/ bzw. redaxo/src/addons/ kopiert.

2. Synchronisierung

Existiert die Datei/Verzeichnis nur in redaxo/src/core/ bzw. redaxo/src/addons/ oder ist neuer als in assets/ wird alles von redaxo/src/core/ bzw. redaxo/src/addons/ nach assets/ kopiert.

php redaxo/bin/console assets:sync

Datenbankschema als PHP exportieren

Bei der Entwicklung von AddOns und PlugIns ist es beim Verwenden von Datenbank-Tabellen notwendig, diese bei der Installation des AddOns/PlugIns anzulegen. Dafür bietet REDAXO eine Schema API, die es erlaubt Tabellen zu erzeugen und zu migrieren.

Der dafür notwendige PHP Code lässt sich mittels Konsolen-Befehl erzeugen, um Ihn anschließend in die install.php zu kopieren.

php redaxo/bin/console db:dump-schema <tabellenname>

package:list

package:listLiefert Informationen über installierte AddOns

Optionen:

• search: filtert die Liste nach dem Suchbegriff
• installed-only (-i): zeigt nur installierte Packages an
• activated-only (-a): zeigt nur installierte & aktivierte Packages an
• using-exit-code: gibt je nachdem, ob es zu den ausgewählten Filtern ein Ergebnis gibt, 0 oder 1 als exit-code zurück (hilfreich bei Skripten)
• json: liefert anstelle einer formatierten Tabelle ein JSON mit Packages.

install:list

install:list Listet alle verfügbaren Addons von redaxo.org auf und zeigt die installierte Version dazu an.

Optionen:

• --search - Filtert die Liste anhand eines Suchbegriffs (vgl. Filterung/Suche im Backend)
• --updates-only - Zeigt nur AddOns an, für die ein Update verfügbar ist
• --json - gibt die Ausgabe als JSON (für z.B. Verarbeitung in Skripten)

package:run-update-script

Mit diesem Command kann das Update-Skript eines Packages manuell ausgeführt werden. Dies ist nützlich zum Testen von update.php-Skripten oder wenn ein Package manuell aktualisiert wurde.

Syntax:

php redaxo/bin/console package:run-update-script <package-name> <from-version>

Parameter:

• <package-name>: Name des Packages (AddOn/PlugIn)
• <from-version>: Vorgängerversion, von der das Update simuliert werden soll

Beispiele:

# Update-Skript von my_addon von Version 1.3.0 auf aktuelle Version ausführen
php redaxo/bin/console package:run-update-script my_addon 1.3.0

# Nützlich beim AddOn-Development zur Update-Skript-Entwicklung
php redaxo/bin/console package:run-update-script demo_addon 2.1.5

Anwendungsfälle:

• AddOn-Entwicklung: Testen von Update-Skripten während der Entwicklung
• Manuelle Updates: Nach manueller Package-Aktualisierung das Update-Skript nachträglich ausführen
• Debugging: Fehlersuche in Update-Prozessen
• Migration: Simulieren von Updates zwischen verschiedenen Versionen

Hinweis: Das Update-Skript wird so ausgeführt, als würde ein Update von der angegebenen Version auf die aktuell installierte Version durchgeführt. Alle Versionsbedingungen in der update.php werden entsprechend ausgewertet.

Entwicklung eigener Konsolen-Skripte

run.php

Die Ausführung eines Konsolen-Befehls erfordert eine eigene Klasse, die auf rex_console_command aufbaut und den ausführbaren Code selbst enthält bzw. aufruft. In dieser Klasse muss es eine Methode execute geben. Die einfachste Form sieht etwa so aus:

use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;

class mein_console_befehl extends rex_console_command {
    protected function execute(InputInterface $input, OutputInterface $output): int
        echo "hallo redaxo"; // beliebiges php hier
        return 0;
    }
}

Falls die implementierte Funktionalität sowohl via Weboberfläche als auch REDAXO Konsole zugreifbar sein sollte, würde es sich anbieten, die entsprechende Logik in einer separaten PHP Klasse zu implementieren und diese aus der o.g. Klasse heraus aufzurufen.

package.yml

Damit der ausführbare Befehl in der REDAXO Konsole zugänglich ist, muss er noch in der package.yml eines AddOns als solcher definiert werden.

Beispiel

console_commands:
    meinaufruf:befehl: mein_console_befehl

Integration der Konsole in Phpstorm

Da die REDAXO Konsole auf der symfony/console Bibliothek aufsetzt, kann die REDAXO Konsole wie eine herkömmliche Symfony-Console mit Phpstorm integriert werden.

Dies ist möglich, sobald das REDAXO-Setup abgeschlossen wurde.

Tipps

Autovervollständigung

Seit REDAXO 5.15 verfügen die Console-Commands über eine integrierte Autocompletion-Funktionalität für viele Parameter und Optionen.

Unterstützte Autocompletion:

Package-Commands:

• package:install [TAB] - Zeigt verfügbare Packages an
• package:uninstall [TAB] - Zeigt installierte Packages an
• package:activate [TAB] - Zeigt deaktivierte Packages an
• package:deactivate [TAB] - Zeigt aktivierte Packages an

User-Commands:

• user:create --login [TAB] - Autocomplete für Benutzer-Parameter
• user:set-password [TAB] - Zeigt vorhandene Benutzer an

Database-Commands:

• db:set-connection [TAB] - Autocomplete für Verbindungsparameter

Setup-Commands:

• Autocomplete für verschiedene Setup-Optionen und Parameter

Beispiele für Autocompletion:

# Package-Namen automatisch vervollständigen
php redaxo/bin/console package:install [TAB][TAB]
# Zeigt: backup, be_style, install, media_manager, ...

# Benutzer-Namen autocomplete
php redaxo/bin/console user:set-password [TAB][TAB]  
# Zeigt: admin, redakteur, editor, ...

# Aktive Packages anzeigen
php redaxo/bin/console package:deactivate [TAB][TAB]
# Zeigt nur aktivierte Packages

Externe Autocompletion:

Zusätzlich zur integrierten Autocompletion kann ein externes Autovervollständigung-Skript verwendet werden, das durch doppeltes Drücken der Tab-Taste ausgelöst wird.

Installation der externen Autocompletion:

# Global installieren via Composer
composer global require bamarni/symfony-console-autocomplete

# Autocompletion für Bash aktivieren
eval "$(symfony-autocomplete --shell bash)"

# Für ZSH
eval "$(symfony-autocomplete --shell zsh)"

Verwendung:

# Nach Installation funktioniert Tab-Completion
php redaxo/bin/console pa[TAB]  # Vervollständigt zu "package:"
php redaxo/bin/console package:i[TAB]  # Zeigt install/init Optionen

Hinweis: Die integrierte Autocompletion funktioniert automatisch ohne zusätzliche Installation und bietet kontextspezifische Vorschläge basierend auf dem aktuellen REDAXO-System.