Runway

Runway ist eine CLI-Anwendung, die Ihnen bei der Verwaltung Ihrer Flight-Anwendungen hilft. Sie kann Controller generieren, alle Routen anzeigen und mehr. Sie basiert auf der hervorragenden adhocore/php-cli-Bibliothek.

Klicken Sie hier, um den Code anzusehen.

Installieren Sie mit Composer.

composer require flightphp/runway

Beim ersten Ausführen von Runway versucht es, eine runway-Konfiguration in app/config/config.php über den Schlüssel 'runway' zu finden.

<?php
// app/config/config.php
return [
    'runway' => [
        'app_root' => 'app/',
        'public_root' => 'public/',
    ],
];

HINWEIS - Ab v1.2.0 ist .runway-config.json veraltet. Bitte migrieren Sie Ihre Konfiguration zu app/config/config.php. Sie können dies einfach mit dem Befehl php runway config:migrate tun.

Projekt-Root-Erkennung

Runway ist intelligent genug, um das Root-Verzeichnis Ihres Projekts zu erkennen, auch wenn Sie es aus einem Unterverzeichnis ausführen. Es sucht nach Indikatoren wie composer.json, .git oder app/config/config.php, um zu bestimmen, wo sich das Projekt-Root befindet. Das bedeutet, dass Sie Runway-Befehle von überall in Ihrem Projekt ausführen können!

Runway verfügt über eine Reihe von Befehlen, die Sie zur Verwaltung Ihrer Flight-Anwendung verwenden können. Es gibt zwei einfache Wege, Runway zu nutzen.

1. Wenn Sie das Skeleton-Projekt verwenden, können Sie php runway [command] vom Root Ihres Projekts ausführen.
2. Wenn Sie Runway als Paket über Composer installiert haben, können Sie vendor/bin/runway [command] vom Root Ihres Projekts ausführen.

Befehlsliste

Sie können eine Liste aller verfügbaren Befehle anzeigen, indem Sie den php runway-Befehl ausführen.

php runway

Befehlshilfe

Für jeden Befehl können Sie die --help-Flagge übergeben, um mehr Informationen darüber zu erhalten, wie man den Befehl verwendet.

php runway routes --help

Hier sind einige Beispiele:

Einen Controller generieren

Basierend auf der Konfiguration in runway.app_root wird der Speicherort einen Controller für Sie im app/controllers/-Verzeichnis generieren.

php runway make:controller MyController

Ein Active Record-Modell generieren

Stellen Sie zuerst sicher, dass Sie das Active Record-Plugin installiert haben. Basierend auf der Konfiguration in runway.app_root wird der Speicherort einen Record für Sie im app/records/-Verzeichnis generieren.

php runway make:record users

Wenn Sie beispielsweise die users-Tabelle mit dem folgenden Schema haben: id, name, email, created_at, updated_at, wird eine Datei ähnlich der folgenden in der Datei app/records/UserRecord.php erstellt:

<?php

declare(strict_types=1);

namespace app\records;

/**
 * ActiveRecord-Klasse für die users-Tabelle.
 * @link https://docs.flightphp.com/awesome-plugins/active-record
 * 
 * @property int $id
 * @property string $name
 * @property string $email
 * @property string $created_at
 * @property string $updated_at
 * // Sie könnten auch Beziehungen hier hinzufügen, sobald Sie sie im $relations-Array definieren
 * @property CompanyRecord $company Beispiel für eine Beziehung
 */
class UserRecord extends \flight\ActiveRecord
{
    /**
     * @var array $relations Legen Sie die Beziehungen für das Modell fest
     *   https://docs.flightphp.com/awesome-plugins/active-record#relationships
     */
    protected array $relations = [];

    /**
     * Konstruktor
     * @param mixed $databaseConnection Die Verbindung zur Datenbank
     */
    public function __construct($databaseConnection)
    {
        parent::__construct($databaseConnection, 'users');
    }
}

Alle Routen anzeigen

Dies zeigt alle Routen an, die derzeit bei Flight registriert sind.

php runway routes

Wenn Sie nur spezifische Routen anzeigen möchten, können Sie eine Flagge übergeben, um die Routen zu filtern.

# Zeige nur GET-Routen an
php runway routes --get

# Zeige nur POST-Routen an
php runway routes --post

# usw.

Wenn Sie entweder ein Paket für Flight erstellen oder eigene benutzerdefinierte Befehle zu Ihrem Projekt hinzufügen möchten, können Sie dies tun, indem Sie ein src/commands/, flight/commands/, app/commands/ oder commands/-Verzeichnis für Ihr Projekt/Paket erstellen. Wenn Sie weitere Anpassungen benötigen, siehe den Abschnitt unten zu Konfiguration.

Um einen Befehl zu erstellen, erweitern Sie einfach die AbstractBaseCommand-Klasse und implementieren mindestens eine __construct-Methode und eine execute-Methode.

<?php

declare(strict_types=1);

namespace flight\commands;

class ExampleCommand extends AbstractBaseCommand
{
    /**
     * Konstruktor
     *
     * @param array<string,mixed> $config Konfiguration aus app/config/config.php
     */
    public function __construct(array $config)
    {
        parent::__construct('make:example', 'Erstelle ein Beispiel für die Dokumentation', $config);
        $this->argument('<funny-gif>', 'Der Name des lustigen GIFs');
    }

    /**
     * Führt die Funktion aus
     *
     * @return void
     */
    public function execute()
    {
        $io = $this->app()->io();

        $io->info('Erstelle Beispiel...');

        // Hier etwas tun

        $io->ok('Beispiel erstellt!');
    }
}

Lesen Sie die adhocore/php-cli-Dokumentation, um mehr darüber zu erfahren, wie Sie eigene benutzerdefinierte Befehle in Ihre Flight-Anwendung einbauen!

Da die Konfiguration ab v1.2.0 zu app/config/config.php verschoben wurde, gibt es einige Hilfsbefehle zur Verwaltung der Konfiguration.

Alte Konfiguration migrieren

Wenn Sie eine alte .runway-config.json-Datei haben, können Sie sie einfach mit dem folgenden Befehl zu app/config/config.php migrieren:

php runway config:migrate

Konfigurationswert setzen

Sie können einen Konfigurationswert mit dem config:set-Befehl setzen. Dies ist nützlich, wenn Sie einen Konfigurationswert aktualisieren möchten, ohne die Datei zu öffnen.

php runway config:set app_root "app/"

Konfigurationswert abrufen

Sie können einen Konfigurationswert mit dem config:get-Befehl abrufen.

php runway config:get app_root

Wenn Sie die Konfiguration für Runway anpassen müssen, können Sie diese Werte in app/config/config.php setzen. Nachfolgend sind einige zusätzliche Konfigurationen, die Sie setzen können:

<?php
// app/config/config.php
return [
    // ... andere Konfigurationswerte ...

    'runway' => [
        // Hier befindet sich Ihr Anwendungsverzeichnis
        'app_root' => 'app/',

        // Dies ist das Verzeichnis, in dem sich Ihre Root-Index-Datei befindet
        'index_root' => 'public/',

        // Dies sind die Pfade zu den Roots anderer Projekte
        'root_paths' => [
            '/home/user/different-project',
            '/var/www/another-project'
        ],

        // Basis-Pfade müssen wahrscheinlich nicht konfiguriert werden, aber es ist hier, falls Sie es möchten
        'base_paths' => [
            '/includes/libs/vendor', // wenn Sie einen wirklich einzigartigen Pfad für Ihr Vendor-Verzeichnis haben oder so
        ],

        // Finale Pfade sind Orte innerhalb eines Projekts, um nach Befehlsdateien zu suchen
        'final_paths' => [
            'src/diff-path/commands',
            'app/module/admin/commands',
        ],

        // Wenn Sie einfach den vollständigen Pfad hinzufügen möchten, tun Sie es ruhig (absolut oder relativ zum Projekt-Root)
        'paths' => [
            '/home/user/different-project/src/diff-path/commands',
            '/var/www/another-project/app/module/admin/commands',
            'app/my-unique-commands'
        ]
    ]
];

Zugriff auf Konfiguration

Wenn Sie die Konfigurationswerte effektiv abrufen müssen, können Sie sie über die __construct-Methode oder die app()-Methode abrufen. Es ist auch wichtig zu beachten, dass, wenn Sie eine app/config/services.php-Datei haben, diese Dienste ebenfalls für Ihren Befehl verfügbar sind.

public function execute()
{
    $io = $this->app()->io();

    // Zugriff auf Konfiguration
    $app_root = $this->config['runway']['app_root'];

    // Zugriff auf Dienste wie vielleicht eine Datenbankverbindung
    $database = $this->config['database']

    // ...
}

Runway hat einige Hilfs-Wrapper, die es einfacher machen, für KI Befehle zu generieren. Sie können addOption und addArgument auf eine Weise verwenden, die ähnlich wie Symfony Console wirkt. Dies ist hilfreich, wenn Sie KI-Tools verwenden, um Ihre Befehle zu generieren.

public function __construct(array $config)
{
    parent::__construct('make:example', 'Erstelle ein Beispiel für die Dokumentation', $config);

    // Der Name-Argument ist nullable und standardmäßig vollständig optional
    $this->addOption('name', 'Der Name des Beispiels', null);
}