Runway

Runway est une application CLI qui vous aide à gérer vos applications Flight. Elle peut générer des contrôleurs, afficher toutes les routes, et plus encore. Elle est basée sur la bibliothèque excellente adhocore/php-cli.

Cliquez ici pour voir le code.

Installez avec composer.

composer require flightphp/runway

La première fois que vous exécutez Runway, il essaiera de trouver une configuration runway dans app/config/config.php via la clé 'runway'.

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

NOTE - À partir de v1.2.0, .runway-config.json est déprécié. Veuillez migrer votre configuration vers app/config/config.php. Vous pouvez le faire facilement avec la commande php runway config:migrate.

Détection de la Racine du Projet

Runway est assez intelligent pour détecter la racine de votre projet, même si vous l'exécutez depuis un sous-répertoire. Il recherche des indicateurs comme composer.json, .git, ou app/config/config.php pour déterminer où se trouve la racine du projet. Cela signifie que vous pouvez exécuter les commandes Runway depuis n'importe où dans votre projet !

Runway dispose d'un certain nombre de commandes que vous pouvez utiliser pour gérer votre application Flight. Il y a deux façons faciles d'utiliser Runway.

1. Si vous utilisez le projet squelette, vous pouvez exécuter php runway [command] depuis la racine de votre projet.
2. Si vous utilisez Runway en tant que package installé via composer, vous pouvez exécuter vendor/bin/runway [command] depuis la racine de votre projet.

Liste des Commandes

Vous pouvez voir une liste de toutes les commandes disponibles en exécutant la commande php runway.

php runway

Aide sur les Commandes

Pour n'importe quelle commande, vous pouvez passer l'option --help pour obtenir plus d'informations sur la façon d'utiliser la commande.

php runway routes --help

Voici quelques exemples :

Générer un Contrôleur

En se basant sur la configuration dans runway.app_root, l'emplacement générera un contrôleur pour vous dans le répertoire app/controllers/.

php runway make:controller MyController

Générer un Modèle Active Record

Assurez-vous d'abord d'avoir installé le plugin Active Record. En se basant sur la configuration dans runway.app_root, l'emplacement générera un enregistrement pour vous dans le répertoire app/records/.

php runway make:record users

Si, par exemple, vous avez la table users avec le schéma suivant : id, name, email, created_at, updated_at, un fichier similaire au suivant sera créé dans le fichier app/records/UserRecord.php :

<?php

declare(strict_types=1);

namespace app\records;

/**
 * Classe ActiveRecord pour la table users.
 * @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
 * // vous pourriez également ajouter des relations ici une fois que vous les définissez dans le tableau $relations
 * @property CompanyRecord $company Exemple de relation
 */
class UserRecord extends \flight\ActiveRecord
{
    /**
     * @var array $relations Définir les relations pour le modèle
     *   https://docs.flightphp.com/awesome-plugins/active-record#relationships
     */
    protected array $relations = [];

    /**
     * Constructeur
     * @param mixed $databaseConnection La connexion à la base de données
     */
    public function __construct($databaseConnection)
    {
        parent::__construct($databaseConnection, 'users');
    }
}

Afficher Toutes les Routes

Cela affichera toutes les routes qui sont actuellement enregistrées avec Flight.

php runway routes

Si vous souhaitez ne voir que des routes spécifiques, vous pouvez passer un drapeau pour filtrer les routes.

# Afficher uniquement les routes GET
php runway routes --get

# Afficher uniquement les routes POST
php runway routes --post

# etc.

Si vous créez un package pour Flight, ou si vous voulez ajouter vos propres commandes personnalisées à votre projet, vous pouvez le faire en créant un répertoire src/commands/, flight/commands/, app/commands/, ou commands/ pour votre projet/package. Si vous avez besoin de personnalisations supplémentaires, voir la section ci-dessous sur la Configuration.

Pour créer une commande, vous étendez simplement la classe AbstractBaseCommand, et implémentez au minimum une méthode __construct et une méthode execute.

<?php

declare(strict_types=1);

namespace flight\commands;

class ExampleCommand extends AbstractBaseCommand
{
    /**
     * Constructeur
     *
     * @param array<string,mixed> $config Config de app/config/config.php
     */
    public function __construct(array $config)
    {
        parent::__construct('make:example', 'Créer un exemple pour la documentation', $config);
        $this->argument('<funny-gif>', 'Le nom du gif drôle');
    }

    /**
     * Exécute la fonction
     *
     * @return void
     */
    public function execute()
    {
        $io = $this->app()->io();

        $io->info('Création de l\'exemple...');

        // Faites quelque chose ici

        $io->ok('Exemple créé !');
    }
}

Consultez la Documentation adhocore/php-cli pour plus d'informations sur la façon de construire vos propres commandes personnalisées dans votre application Flight !

Puisque la configuration a été déplacée vers app/config/config.php à partir de v1.2.0, il y a quelques commandes d'aide pour gérer la configuration.

Migrer l'Ancienne Configuration

Si vous avez un ancien fichier .runway-config.json, vous pouvez facilement le migrer vers app/config/config.php avec la commande suivante :

php runway config:migrate

Définir une Valeur de Configuration

Vous pouvez définir une valeur de configuration en utilisant la commande config:set. Cela est utile si vous voulez mettre à jour une valeur de configuration sans ouvrir le fichier.

php runway config:set app_root "app/"

Obtenir une Valeur de Configuration

Vous pouvez obtenir une valeur de configuration en utilisant la commande config:get.

php runway config:get app_root

Si vous avez besoin de personnaliser la configuration pour Runway, vous pouvez définir ces valeurs dans app/config/config.php. Voici quelques configurations supplémentaires que vous pouvez définir :

<?php
// app/config/config.php
return [
    // ... autres valeurs de config ...

    'runway' => [
        // C'est là que se trouve votre répertoire d'application
        'app_root' => 'app/',

        // C'est le répertoire où se trouve votre fichier index racine
        'index_root' => 'public/',

        // Ce sont les chemins vers les racines d'autres projets
        'root_paths' => [
            '/home/user/different-project',
            '/var/www/another-project'
        ],

        // Les chemins de base n'ont probablement pas besoin d'être configurés, mais ils sont là si vous le souhaitez
        'base_paths' => [
            '/includes/libs/vendor', // si vous avez un chemin vraiment unique pour votre répertoire vendor ou quelque chose
        ],

        // Les chemins finaux sont des emplacements dans un projet pour rechercher les fichiers de commande
        'final_paths' => [
            'src/diff-path/commands',
            'app/module/admin/commands',
        ],

        // Si vous voulez juste ajouter le chemin complet, allez-y (absolu ou relatif à la racine du projet)
        'paths' => [
            '/home/user/different-project/src/diff-path/commands',
            '/var/www/another-project/app/module/admin/commands',
            'app/my-unique-commands'
        ]
    ]
];

Accéder à la Configuration

Si vous avez besoin d'accéder efficacement aux valeurs de configuration, vous pouvez y accéder via la méthode __construct ou la méthode app(). Il est également important de noter que si vous avez un fichier app/config/services.php, ces services seront également disponibles pour votre commande.

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

    // Accéder à la configuration
    $app_root = $this->config['runway']['app_root'];

    // Accéder aux services comme peut-être une connexion à la base de données
    $database = $this->config['database']

    // ...
}

Runway dispose de quelques enveloppes d'aide qui facilitent la génération de commandes par l'IA. Vous pouvez utiliser addOption et addArgument d'une manière qui ressemble à Symfony Console. Cela est utile si vous utilisez des outils IA pour générer vos commandes.

public function __construct(array $config)
{
    parent::__construct('make:example', 'Créer un exemple pour la documentation', $config);

    // L'argument mode est nullable et par défaut complètement optionnel
    $this->addOption('name', 'Le nom de l\'exemple', null);
}