Zum Inhalt springen

Start

Willkommen bei der DotApper CLI, der offiziellen Kommandozeilenschnittstelle für das dotApp PHP Framework. DotApper ist darauf ausgelegt, Ihren Entwicklungsablauf zu vereinfachen, sodass Sie dotApp-Projekte mit einem klaren und leistungsfähigen Befehlssatz einrichten, verwalten und erweitern können.

Was ist die DotApper CLI?

Die DotApper CLI ist ein schlankes Werkzeug, mit dem Sie:

  • das dotApp PHP Framework installieren und aktualisieren.
  • Module, Controller, Middleware und Modelle erstellen und verwalten.
  • Projekt-Assets wie Routen und .htaccess-Dateien erzeugen und optimieren.
  • die Produktivität mit einer intuitiven Kommandozeile steigern.

Mit Fokus auf Einfachheit und Effizienz ist die DotApper CLI ideal für Entwickler, die moderne Webanwendungen bauen möchten, ohne sich mit wiederkehrenden Einrichtungsaufgaben aufzuhalten.

Warum die DotApper CLI verwenden?

  • Schnelle Einrichtung: Installieren Sie dotApp in Sekunden mit einem einzigen Befehl.
  • Modularer Workflow: Erstellen und strukturieren Sie Module für skalierbare Projekte.
  • Entwicklerfreundlich: Klare Befehle und hilfreiche Ausgaben sparen Zeit.
  • Nahtlose Integration: Arbeitet Hand in Hand mit der modularen Architektur des dotApp-Frameworks.

Erste Schritte

Bereit loszulegen? Wechseln Sie zum Abschnitt Installation, um die DotApper CLI einzurichten und Ihr erstes Projekt zu starten. Oder erkunden Sie den Abschnitt Befehle, um den gesamten Werkzeugumfang kennenzulernen.

Schnellstart-Beispiel:

# Install dotApp with DotApper CLI
php dotapper.php --install

Weitere Informationen finden Sie in der vollständigen dotApp-Dokumentation oder wenden Sie sich an unser Support-Team.

Mit Stolz hergestellt in der Slowakei 🇸🇰

Installation

Die Installation der DotApper CLI ist einfach und erfordert nur den Download einer einzigen Datei, dotapper.php, auf Ihren Rechner. Dieser Abschnitt erklärt, wie Sie die DotApper CLI beziehen und für die Nutzung vorbereiten.

Voraussetzungen

Stellen Sie vor der Installation der DotApper CLI sicher, dass Ihre Umgebung die folgende Anforderung erfüllt:

  • PHP: Version 7.4 oder höher, mit Kommandozeilenzugriff zum Ausführen von PHP-Skripten.

DotApper CLI installieren

Um die DotApper CLI zu installieren, laden Sie die Datei dotapper.php wie folgt herunter:

  1. Öffnen Sie Ihren Webbrowser und rufen Sie den folgenden Link auf: https://github.com/dotsystems-sk/DotApp/raw/refs/heads/main/dotapper.php.
  2. Der Browser zeigt den Quellcode von dotapper.php an. Klicken Sie mit der rechten Maustaste irgendwo auf die Seite und wählen Sie Seite speichern unter (oder eine vergleichbare Option, abhängig von Ihrem Browser).
  3. Speichern Sie die Datei als dotapper.php in das gewünschte Verzeichnis (z. B. Ihren Projektordner oder ein Werkzeuge-Verzeichnis).
  4. Prüfen Sie, ob die Datei korrekt gespeichert wurde, indem Sie ein Terminal öffnen und ausführen: 
    
php dotapper.php --help
    Daraufhin sollte eine Liste der verfügbaren DotApper-CLI-Befehle erscheinen und bestätigen, dass das Werkzeug einsatzbereit ist.

Hinweise

  • Dateiablage: Sie können dotapper.php in einem beliebigen Verzeichnis ablegen; üblicherweise liegt sie im Projektstamm für den einfachen Zugriff.
  • Ausführung: Führen Sie DotApper-CLI-Befehle mit php dotapper.php [command] aus dem Verzeichnis aus, in dem die Datei liegt.
  • Nächste Schritte: Erfahren Sie im Abschnitt Befehle, wie Sie mit der DotApper CLI dotApp-Projekte verwalten.
  • Fehlerbehebung: Wenn der Befehl --help fehlschlägt, stellen Sie sicher, dass PHP 7.4+ installiert und in Ihrem Terminal verfügbar ist. Häufige Probleme finden Sie in den FAQ.

Mit heruntergeladenem dotapper.php können Sie die Befehle erkunden. Wechseln Sie zum Abschnitt Befehle, um mit der DotApper CLI zu starten.

Befehle

Die DotApper CLI stellt einen leistungsfähigen Befehlssatz bereit, um die Entwicklung mit dem dotApp PHP Framework zu vereinfachen. Dieser Abschnitt beschreibt alle verfügbaren Befehle, ihren Zweck und ihre Verwendung. Befehle werden im Terminal mit dem Skript dotapper.php aus dem Verzeichnis ausgeführt, in dem es liegt.

Befehlsstruktur

Alle DotApper-CLI-Befehle folgen diesem Format: 


php dotapper.php [command]

Ersetzen Sie [command] durch den jeweiligen Befehl und seine Parameter wie unten beschrieben. Um eine Liste aller Befehle zu sehen, führen Sie aus: 


php dotapper.php --help

Verfügbare Befehle

Die folgenden Befehle stehen in der DotApper CLI zur Verfügung. Jeder vereinfacht Aufgaben wie die Installation des Frameworks, die Verwaltung von Modulen und die Inspektion von Routen.

--help

Zeigt eine Liste aller verfügbaren Befehle und ihrer Beschreibungen.

Beispiel:

php dotapper.php --help

Ergebnis: Gibt ein Hilfemenü mit allen Befehlen aus, z. B. --install, --create-module usw.

--install

Installiert eine frische Kopie des dotApp PHP Framework im aktuellen Verzeichnis und erzeugt dessen Verzeichnisstruktur und Konfigurationsdateien.

Beispiel:

php dotapper.php --install

Ergebnis: Richtet das dotApp-Framework ein, einschließlich Verzeichnissen wie app/, public/ und der Datei app/config.php.

--update

Aktualisiert das dotApp-Framework auf die neueste Version und behält vorhandene Konfigurationsdateien und Module bei.

Beispiel:

php dotapper.php --update

Ergebnis: Lädt die neuesten dotApp-Core-Dateien herunter und wendet sie an, wobei app/config.php und die Modulverzeichnisse unangetastet bleiben.

--create-module=

Erstellt ein neues Modul mit dem angegebenen Namen und initialisiert dessen Verzeichnisstruktur für Controller, Middleware und Modelle.

Beispiel:

php dotapper.php --create-module=Blog

Ergebnis: Erstellt ein Modul Blog in app/modules/Blog/ mit Unterverzeichnissen für die Komponenten.

--modules

Listet alle Module auf, die derzeit im dotApp-Projekt vorhanden sind.

Beispiel:

php dotapper.php --modules

Ergebnis: Gibt eine Liste der Modulnamen aus, z. B. Blog, Auth, Shop.

--module= --create-controller=

Erstellt einen neuen Controller im angegebenen Modul.

Beispiel:

php dotapper.php --module=Blog --create-controller=ArticleController

Ergebnis: Erzeugt ArticleController.php in app/modules/Blog/controllers/.

--module= --create-middleware=

Erstellt eine neue Middleware im angegebenen Modul.

Beispiel:

php dotapper.php --module=Blog --create-middleware=AuthMiddleware

Ergebnis: Erzeugt AuthMiddleware.php in app/modules/Blog/middleware/.

--module= --create-model=

Erstellt ein neues Modell im angegebenen Modul.

Beispiel:

php dotapper.php --module=Blog --create-model=PostModel

Ergebnis: Erzeugt PostModel.php in app/modules/Blog/models/.

--list-routes

Listet alle definierten Routen in der dotApp-Anwendung auf, einschließlich HTTP-Methoden, Pfade, zugehöriger Controller und Middleware (Before- und After-Hooks).

Beispiel:

php dotapper.php --list-routes

Ergebnis: Gibt eine detaillierte Routenliste aus.

Anwendungsfall: Nützlich zum Debuggen von Routing-Problemen oder zum Dokumentieren der Routing-Struktur der Anwendung.

--list-route=

Zeigt alle Routen, die zum angegebenen Pfad passen, einschließlich HTTP-Methoden, zugehöriger Controller und Middleware (Before- und After-Hooks). Der Pfad kann exakt sein (z. B. / für die Startseite) oder partiell (z. B. /documentation/).

Beispiel 1: Startseiten-Routen

php dotapper.php --list-route=/

Ergebnis: Gibt Routen aus, die zu / passen.

Beispiel 2: Dokumentations-Routen

php dotapper.php --list-route=/documentation/

Ergebnis: Gibt Routen aus, die zu /documentation/ passen.

Anwendungsfall: Hilft zu erkennen, welche Controller und Middleware für eine bestimmte URL ausgelöst werden, und unterstützt so Debugging oder Routenoptimierung.

--create-htaccess

Erstellt oder erzeugt neu eine .htaccess-Datei im Verzeichnis public/, um URL-Rewriting für Apache-Server zu konfigurieren.

Beispiel:

php dotapper.php --create-htaccess

Ergebnis: Erzeugt eine für das Routing von dotApp optimierte .htaccess-Datei.

--optimize-modules

Optimiert das Laden von Modulen in Projekten mit vielen Modulen und verbessert die Leistung durch Caching von Modul-Metadaten.

Beispiel:

php dotapper.php --optimize-modules

Ergebnis: Erstellt oder aktualisiert einen Modul-Cache, um die Ladezeit zu verkürzen.

Befehlsübersicht

Die folgende Tabelle bietet eine schnelle Referenz aller DotApper-CLI-Befehle:

Befehl Beschreibung
--help Liste der verfügbaren Befehle anzeigen
--install Eine frische Kopie des dotApp-Frameworks installieren
--update dotApp-Core auf die neueste Version aktualisieren
--create-module= Ein neues Modul erstellen
--modules Alle Module auflisten
--module= --create-controller= Einen neuen Controller im angegebenen Modul erstellen
--module= --create-middleware= Eine neue Middleware im angegebenen Modul erstellen
--module= --create-model= Ein neues Modell im angegebenen Modul erstellen
--list-routes Alle Routen mit Controllern und Middleware auflisten
--list-route= Routen auflisten, die zum angegebenen Pfad passen, mit Controllern und Middleware
--create-htaccess Eine .htaccess-Datei erstellen oder neu erzeugen
--optimize-modules Das Laden von Modulen optimieren

Hinweise

  • Führen Sie Befehle aus dem Verzeichnis aus, das dotapper.php enthält.
  • Befehle wie --install, --create-module und --list-routes erfordern eine gültige dotApp-Projektstruktur im aktuellen Verzeichnis.
  • Praktische Beispiele zur Verwendung dieser Befehle finden Sie im Abschnitt Verwendung.
  • Wenn ein Befehl fehlschlägt, schlagen Sie in den FAQ nach oder kontaktieren Sie den Support.

Um diese Befehle in Aktion zu sehen, schauen Sie im Abschnitt Verwendung nach praxisnahen Beispielen.

Erweitert

Die DotApper CLI bietet erweiterte Funktionen für Entwickler, die Abläufe automatisieren, komplexe Aufgaben skripten oder die Funktionalität für eigene Anforderungen in dotApp PHP Framework-Projekten erweitern möchten. Dieser Abschnitt behandelt Skripte, Automatisierung, das Kombinieren von Befehlen und Tipps zum Erweitern der DotApper CLI.

Skripten mit der DotApper CLI

Sie können mehrere DotApper-CLI-Befehle in Shell-Skripten (z. B. Bash oder PowerShell) kombinieren, um wiederkehrende Aufgaben zu automatisieren, etwa das Einrichten eines neuen Projekts mit vordefinierten Modulen und Konfigurationen.

Beispiel: Bash-Skript für die Projekteinrichtung

#!/bin/bash
# setup_project.sh

echo "Setting up new dotApp project..."
php dotapper.php --install
php dotapper.php --create-module=Blog
php dotapper.php --module=Blog --create-controller=ArticleController
php dotapper.php --module=Blog --create-middleware=AuthMiddleware
php dotapper.php --module=Blog --create-model=PostModel
php dotapper.php --create-htaccess
echo "Project setup complete!"

Verwendung: Speichern Sie das Skript als setup_project.sh, machen Sie es ausführbar (chmod +x setup_project.sh) und führen Sie es aus: 


./setup_project.sh

Ergebnis: Installiert dotApp, erstellt ein Modul Blog mit Controller, Middleware und Modell und erzeugt eine .htaccess-Datei.

FAQ

Dieser Abschnitt beantwortet häufig gestellte Fragen zum Werkzeug DotApper CLI für das dotApp PHP Framework. Er behandelt typische Probleme, Schritte zur Fehlerbehebung und Klarstellungen, damit Sie die DotApper CLI wirksam einsetzen können.

1. Warum erhalte ich den Fehler „command not found“, wenn ich php dotapper.php ausführe?

Dieser Fehler tritt typischerweise auf, wenn PHP nicht installiert ist, im Terminal nicht verfügbar ist oder wenn dotapper.php nicht im aktuellen Verzeichnis liegt.

Lösung:
  • Prüfen Sie, ob PHP installiert ist und die Mindestversion (7.4+) erfüllt: 
    
php --version
    Ist PHP nicht installiert, laden Sie es von php.net herunter.
  • Stellen Sie sicher, dass Sie sich im Verzeichnis mit dotapper.php befinden. Prüfen Sie mit: 
    
ls | grep dotapper.php
    Fehlt die Datei, laden Sie sie wie im Abschnitt Installation beschrieben herunter.
  • Fügen Sie PHP zum PATH Ihres Systems hinzu, wenn es installiert, aber nicht erreichbar ist. Beispiel unter Linux: 
    
export PATH=$PATH:/path/to/php

2. Warum schlägt --install mit einem Berechtigungsfehler fehl?

Der Befehl --install benötigt Schreibrechte im aktuellen Verzeichnis, um Dateien und Verzeichnisse des dotApp-Frameworks anzulegen.

Lösung:
  • Verzeichnisberechtigungen prüfen: 
    
ls -ld .
    Stellen Sie sicher, dass Ihr Benutzer Schreibzugriff hat.
  • Schreibrechte erteilen: 
    
chmod -R u+w .
  • Alternativ den Befehl mit erhöhten Rechten ausführen (mit Vorsicht): 
    
sudo php dotapper.php --install

3. Was tun, wenn --list-routes keine Routen anzeigt?

Wenn --list-routes oder --list-route= eine leere Liste zurückgibt, hat Ihr dotApp-Projekt möglicherweise keine definierten Routen oder die Projektstruktur ist unvollständig.

Lösung:
  • Stellen Sie sicher, dass das dotApp-Framework installiert ist: 
    
php dotapper.php --install
  • Prüfen Sie, ob Routen in der module.init.php des Moduls definiert sind. Zum Beispiel: 
    
Router::get('/home', 'HelloWorld:Home@index!', Router::STATIC_ROUTE);
  • Suchen Sie nach Fehlern im Projektverzeichnis, indem Sie ausführen: 
    
php dotapper.php --list-routes
    Bleiben Fehler bestehen, stellen Sie sicher, dass die Datei app/config.php existiert und gültig ist.

4. Kann ich die DotApper CLI ohne Installation von dotApp verwenden?

Einige Befehle (z. B. --help, --install) funktionieren ohne dotApp-Projekt, die meisten Befehle (z. B. --update, --create-module, --list-routes) erfordern jedoch eine dotApp-Projektstruktur im aktuellen Verzeichnis.

Lösung:
  • Führen Sie --install aus, um ein dotApp-Projekt einzurichten: 
    
php dotapper.php --install
  • Alternativ können Sie mit --help Befehle ohne Projekt erkunden: 
    
php dotapper.php --help

5. Warum überschreibt --update meine eigenen Dateien?

Der Befehl --update ist so ausgelegt, dass app/config.php und Modulverzeichnisse erhalten bleiben, er kann jedoch Core-Dateien des Frameworks überschreiben. Eigene Änderungen an Core-Dateien gehen verloren.

Lösung:
  • Sichern Sie Ihr Projekt, bevor Sie --update ausführen: 
    
cp -r . /path/to/backup
  • Vermeiden Sie Änderungen an Core-Dateien des Frameworks. Nutzen Sie stattdessen Module für eigene Funktionalität (siehe Verwendung).
  • Wurden eigene Dateien überschrieben, stellen Sie sie aus der Sicherung wieder her und wenden Sie die Änderungen erneut in einem Modul an.

6. Wie debugge ich Probleme mit --list-route=?

Wenn --list-route= nicht die erwarteten Routen, Controller oder Middleware zurückgibt, ist die Route möglicherweise nicht registriert oder das Pfadformat ist falsch.

Lösung:
  • Stellen Sie sicher, dass der Pfad korrekt ist, einschließlich führender/abschließender Schrägstriche (z. B. / oder /documentation/).
  • Führen Sie --list-routes aus, um alle Routen zu sehen und zu bestätigen, dass der Zielpfad existiert: 
    
php dotapper.php --list-routes
  • Prüfen Sie Ihre Routing-Definitionen in Controllern oder Routing-Dateien auf Fehler.
  • Fehlen Middleware oder Controller, prüfen Sie, ob sie in der Modulkonfiguration korrekt registriert sind.

7. Kann ich DotApper-CLI-Befehle global ausführen?

Die DotApper CLI ist dafür gedacht, aus dem Projektverzeichnis mit dotapper.php zu laufen. Sie können sie jedoch global verfügbar machen, indem Sie sie zum PATH Ihres Systems hinzufügen.

Lösung:
  • Verschieben Sie dotapper.php in ein Verzeichnis in Ihrem PATH (z. B. /usr/local/bin/ unter Linux): 
    
sudo mv dotapper.php /usr/local/bin/dotapper
sudo chmod +x /usr/local/bin/dotapper
  • Führen Sie Befehle global aus einem beliebigen Verzeichnis aus: 
    
php dotapper --help
  • Hinweis: Für die meisten Befehle müssen Sie sich weiterhin in einem dotApp-Projektverzeichnis befinden.

8. Was tun, wenn ein Befehl ohne klare Fehlermeldung fehlschlägt?

Manche Fehler entstehen durch die PHP-Konfiguration, Dateiberechtigungen oder eine unvollständige dotApp-Einrichtung.

Lösung:
  • Aktivieren Sie ausführliche PHP-Fehler, indem Sie dies (vorübergehend) in dotapper.php einfügen: 
    
ini_set('display_errors', 1);
ini_set('display_startup_errors', 1);
error_reporting(E_ALL);
  • Prüfen Sie die PHP-Logs auf detaillierte Fehler (der Speicherort hängt von Ihrer Serverkonfiguration ab).
  • Stellen Sie sicher, dass alle Voraussetzungen erfüllt sind (siehe Installation).