Laravel - Console artisanale

Le framework Laravel fournit trois outils principaux d'interaction via la ligne de commande, à savoir : Artisan, Ticker et REPL. Ce chapitre explique en détail Artisan.

Introduction à l'Artisan

Artisan est l'interface de ligne de commande fréquemment utilisée dans Laravel et comprend un ensemble de commandes utiles pour développer une application Web.

Exemple

Voici une liste de quelques commandes dans Artisan ainsi que leurs fonctionnalités respectives −

Pour démarrer le projet Laravel

php artisan serve

Pour activer le mécanisme de mise en cache

php artisan route:cache

Pour afficher la liste des commandes disponibles prises en charge par Artisan

php artisan list

Pour afficher l'aide sur n'importe quelle commande et afficher les options et arguments disponibles

php artisan help serve

La capture d'écran suivante montre le résultat des commandes données ci-dessus −

Commandes d'écriture

En plus des commandes répertoriées dans Artisan, un utilisateur peut également créer une commande personnalisée qui peut être utilisée dans l'application Web. Veuillez noter que les commandes sont stockées dans le répertoire app/console/commands.

La commande par défaut pour créer une commande définie par l'utilisateur est présentée ci-dessous −

php artisan make:console <name-of-command>

Une fois que vous avez tapé la commande ci-dessus, vous pouvez voir le résultat comme indiqué dans la capture d'écran ci-dessous −

Le fichier créé pour DefaultCommand est nommé DefaultCommand.php et est affiché ci-dessous −

<?php

namespace App\Console\Commands;
use Illuminate\Console\Command;

class DefaultCommand extends Command{
   /**
      * The name and signature of the console command.
      *
      * @var string
   */
   
   protected $signature = &#39;command:name&#39;;
   
   /**
      * The console command description.
      *
      * @var string
   */
   
   protected $description = &#39;Command description&#39;;
   
   /**
      * Create a new command instance.
      *
      * @return void
   */
   
   public function __construct() {
      parent::__construct();
   }
   
   /**
      * Execute the console command.
      *
      * @return mixed
   */
   
   public function handle() {
      //
   }
}

Ce fichier comprend la signature et la description de la commande définie par l'utilisateur. La fonction publique nommée handle exécute les fonctionnalités lorsque la commande est exécutée. Ces commandes sont enregistrées dans le fichier Kernel.php dans le même répertoire.

Vous pouvez également créer le calendrier des tâches pour la commande définie par l'utilisateur comme indiqué dans le code suivant −

<?php

namespace App\Console;

use Illuminate\Console\Scheduling\Schedule;
use Illuminate\Foundation\Console\Kernel as ConsoleKernel;

class Kernel extends ConsoleKernel {
   /**
      * The Artisan commands provided by your application.
      *
      * @var array
   */
   
   protected $commands = [
      // Commands\Inspire::class,
      Commands\DefaultCommand::class
   ];
   
   /**
      * Define the application&#39;s command schedule.
      *
      * @param \Illuminate\Console\Scheduling\Schedule $schedule
      * @return void
   */
   
   protected function schedule(Schedule $schedule) {
      // $schedule->command(&#39;inspire&#39;)
      // ->hourly();
   }
}

Notez que le planning des tâches pour la commande donnée est défini dans la fonction nommée schedule, qui comprend un paramètre de planification des tâches qui prend le paramètre hourly.

Les commandes sont enregistrées dans le tableau des commandes, qui comprend le chemin et le nom des commandes.

Une fois la commande enregistrée, elle est répertoriée dans les commandes Artisan. Les valeurs incluses dans la section signature et description seront affichées lorsque vous appellerez l'attribut d'aide de la commande spécifiée.

Voyons comment afficher les attributs de notre commande DefaultCommand. Vous devez utiliser la commande comme indiqué ci-dessous −

php artisan help DefaultCommand

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!