Artisan Befehlszeile

• Einführung
  • Tinker-Befehl (REPL)
• Befehl schreiben
  • Befehl generieren
  • Befehlsstruktur
  • Schließbefehl
• Eingabeerwartungen definieren
  • Parameter
  • Optionen
  • Eingabearray
  • Eingabebeschreibung
• E/A Befehl
  • Eingabe abrufen
  • Interaktive Eingabe
  • Ausgabe schreiben
• Befehl registrieren
• Befehle programmgesteuert ausführen
  • Befehle von anderen Befehlen aufrufen

Einführung

Handwerklich Es handelt sich um die Befehlszeilenschnittstelle, die mit Laravel geliefert wird. Sie bietet viele Befehle, die Ihnen beim Erstellen von Laravel-Anwendungen helfen. Um eine Liste aller verfügbaren Artisan-Befehle anzuzeigen, verwenden Sie den Befehl list:

php artisan list

Jeder Befehl enthält eine Hilfeschnittstelle, die die verfügbaren Argumente und Optionen für den Befehl anzeigt und zusammenfasst. Fügen Sie einfach help vor dem Befehl hinzu, um die Befehlshilfeschnittstelle anzuzeigen:

php artisan help migrate

Tinker Command (REPL)

Alle Laravel-Anwendungen umfassen Tinker, a Das PsySH-Paket bietet Unterstützung für die REPL. Mit Tinker können Sie über die Befehlszeile mit Ihrer gesamten Laravel-Anwendung interagieren. Beinhaltet Eloquent ORM, Aufgaben, Ereignisse und mehr. Führen Sie den Artisan-Befehl tinker aus, um die Tinker-Umgebung aufzurufen:

php artisan tinker

Sie können die Tinker-Konfigurationsdatei veröffentlichen, indem Sie den Befehl vendor:publish verwenden:

php artisan vendor:publish --provider="Laravel\Tinker\TinkerServiceProvider"

Befehls-Whitelist

Tinker verwendet eine Whitelist, um zu bestimmen, welche Artisan-Befehle in der Shell ausgeführt werden dürfen. Standardmäßig können Sie die Befehle clear-compiled, down, env, inspire, migrate, optimize und up ausführen. Wenn Sie weitere Whitelist-Befehle hinzufügen möchten, können Sie diese zum Array tinker.php in der Konfigurationsdatei commands hinzufügen:

'commands' => [ 
   // App\Console\Commands\ExampleCommand::class,
   ],

Blacklist-Alias

Typischerweise Tinker fügt den Klassen in Tinker automatisch Aliase hinzu, je nach Ihren Anforderungen. Allerdings möchten Sie möglicherweise einigen Klassen keine Aliase hinzufügen. Sie können dies tun, indem Sie diese Klassen im Array tinker.php in der Konfigurationsdatei dont_alias auflisten:

'dont_alias' => [ 
   App\User::class,
 ],

Schreiben Sie den Befehl

Zusätzlich zu den von Artisan bereitgestellten Befehlen können Sie auch Ihre eigenen benutzerdefinierten Befehle erstellen. Befehle werden normalerweise im Verzeichnis app/Console/Commands gespeichert. Solange Ihre Befehle jedoch von Composer geladen werden können, können Sie Ihren eigenen Speicherort wählen.

Befehl generieren

Um einen neuen Befehl zu erstellen, verwenden Sie den Artisan-Befehl make:command. Dieser Befehl erstellt eine neue Befehlsklasse im Verzeichnis app/Console/Commands. Machen Sie sich keine Sorgen, wenn dieses Verzeichnis in Ihrer Anwendung nicht vorhanden ist, da es erstellt wird, wenn Sie den Artisan-Befehl make:command zum ersten Mal ausführen. Der generierte Befehl enthält die Attribute und Methoden, die standardmäßig in allen Befehlen vorhanden sind:

php artisan make:command SendEmails

Befehlsstruktur

Befehl ausführen Abschließend sollten Sie zunächst die Attribute signature und description ausfüllen, damit Sie php artisan list eingeben können Seien Sie in der Lage, die Verwendung klar zu verstehen. Die Methode handle wird beim Ausführen des Befehls aufgerufen. In dieser Methode können Sie die Befehlslogik platzieren.

{tip} Für eine bessere Code-Wiederverwendung ist es am besten, Ihren Konsolencode kompakt zu halten und die Fertigstellung auf den Anwendungsdienst zu verschieben. Im folgenden Beispiel fügen wir eine Serviceklasse ein, um die Aufgabe des E-Mail-Versands abzuschließen.

Schauen wir uns ein einfaches Beispiel an. Wir können alle benötigten Abhängigkeiten in die Methode handle einfügen. Der Laravel-Dienstcontainer fügt automatisch alle Abhängigkeiten mit Typeinschränkungen in den Konstruktor ein:

<?php
    namespace App\Console\Commands;
    use App\User;use App\DripEmailer;
    use Illuminate\Console\Command;
    class SendEmails extends Command{   
     /**
     * The name and signature of the console command.
     *
     * @var string
     */   
   protected $signature = 'email:send {user}';  
    /**
     * The console command description.
     *
     * @var string
     */   
    protected $description = 'Send drip e-mails to a user';    
     /**
     * Create a new command instance.
     *
     * @return void
     */  
   public function __construct()    {    
      parent::__construct();   
     }    
     /**
     * Execute the console command.
     *
     * @param  \App\DripEmailer  $drip
     * @return mixed
     */  
   public function handle(DripEmailer $drip)  
     {     
        $drip->send(User::find($this->argument('user')));  
      }
   }

Abschlussbefehle

Abschlussbasierte Befehle bieten eine Möglichkeit, Klassen zu verwenden, anstatt Konsolenbefehle zu definieren. Ebenso ist das Closing-Routing eine Alternative zu Controllern, und Closing-Befehle können als Alternative zu Befehlsklassen betrachtet werden. In der app/Console/Kernel.php-Methode der commands-Datei lädt Laravel die routes/console.php-Datei:

/**
 * Register the Closure based commands for the application.
 *
 * @return void
 */
 protected function commands(){ 
    require base_path('routes/console.php');
 }

Obwohl diese Datei kein HTTP-Routing definiert, definiert sie den konsolenbasierten Einstiegspunkt (Routing) zu die Anwendungsmitte. In dieser Datei können Sie alle Schließungsrouten mit der Methode Artisan::command definieren. Die command-Methode akzeptiert zwei Parameter: Befehlsname und einen Abschluss, der die Befehlsparameter und -optionen akzeptiert:

Artisan::command('build {project}', function ($project) { 
   $this->info("Building {$project}!");
});

Der Abschluss bindet die zugrunde liegende Befehlsinstanz, da Sie Zugriff auf alle fähigen haben Alle Hilfsmethoden in der vollständigen Befehlsklasse.

Typhinweisabhängige Abhängigkeiten

Befehlsabschlüsse können nicht nur Parameter und Optionen für Befehle empfangen, sondern auch Typhinweise aus dem Servicecontainer verwenden Lösen Sie andere Abhängigkeiten auf in:

use App\User;
use App\DripEmailer;Artisan::command('email:send {user}', function (DripEmailer $drip, $user) { 
   $drip->send(User::find($user));
});

Beschreibung des Abschlussbefehls

Wenn Sie einen Abschlussbefehl definieren, sollten Sie die Methode describe verwenden, um dem Befehl eine Beschreibung hinzuzufügen. Diese Beschreibung wird angezeigt, wenn Sie den Befehl php artisan list oder php artisan help ausführen:

Artisan::command('build {project}', function ($project) {
    $this->info("Building {$project}!");
 })->describe('Build the project');

Ausgabeerwartungen definieren

Beim Schreiben von Konsolenbefehlen werden Benutzereingaben normalerweise über Parameter und Optionen erfasst. Mit Laravel ist es sehr praktisch, über das Attribut signature zu definieren, was der Benutzer eingeben soll. signature Ermöglicht die Definition von Befehlsnamen, Parametern und Optionen mithilfe einer einzigen und gut lesbaren Routing-ähnlichen Syntax.

Parameter

Alle vom Benutzer bereitgestellten Parameter und Optionen sind in geschweifte Klammern eingeschlossen. Im folgenden Beispiel definiert dieser Befehl einen Parameter, der sein muss: user:

/**
 * The name and signature of the console command.
 *
 * @var string
 */
 protected $signature = 'email:send {user}';

Sie können auch optionale Parameter erstellen und deren Standardwerte definieren:

// 可选参数...
email:send {user?}
// 带有默认值的可选参数...
email:send {user=foo}

Optionen

Optionen sind, ähnlich wie Parameter, ein weiteres Format für Benutzereingaben. Wenn Optionen in der Befehlszeile angegeben werden, werden ihnen zwei Bindestriche ( -- ) vorangestellt. Es gibt zwei Arten von Optionen: einen Wert erhalten und keinen Wert erhalten. Eine Option, die keinen Wert akzeptiert, ist wie ein boolescher „Schalter“. Schauen wir uns ein Beispiel für diese Art von Option an:

/**
 * 命令行的名称及签名。
 *
 * @var string
 */
 protected $signature = 'email:send {user} {--queue}';

In diesem Beispiel kann der Schalter --queue beim Aufruf des Artisan-Befehls angegeben werden. Der Wert dieser Option ist --queue, wenn der Schalter true übergeben wird, false andernfalls:

php artisan email:send 1 --queue

Optionen mit einem Wert

Als nächstes schauen wir uns eine Option mit einem Wert an. Wenn Sie möchten, dass der Benutzer einen Wert für eine Option angeben muss, müssen Sie ein Gleichheitszeichen = als Suffix an das Ende des Optionsnamens anhängen:

/**
 * 命令行的名称及签名。
 *
 * @var string
 */
 protected $signature = 'email:send {user} {--queue=}';

In diesem Beispiel kann der Benutzer dies tun Übergeben Sie den Wert der Option wie folgt. Anzeige:

php artisan email:send 1 --queue=default

Sie können den Standardwert für eine Option auch festlegen, indem Sie den Standardwert nach dem Optionsnamen angeben. Wenn der Benutzer keinen Optionswert übergibt, wird der eingestellte Standardwert verwendet:

email:send {user} {--queue=default}

Die Optionsabkürzung

muss in angegeben werden. Um beim Definieren einer Option eine Abkürzung anzugeben, können Sie diese vor dem Optionsnamen mit < angeben Das Trennzeichen 🎜> trennt die Abkürzung vom vollständigen Optionsnamen: |

email:send {user} {--Q|queue}

verwenden. Schauen wir uns zunächst ein Beispiel für einen Array-Parameter an: *

email:send {user*}

-Parameters der Reihe nach an die Befehlszeile übergeben werden. Der folgende Befehl legt beispielsweise den Benutzer fest hat einen Wert von user: ['foo', 'bar']

php artisan email:send foo bar

email:send {user} {--id=*}
php artisan email:send --id=1 --id=2

/**
 * 命令行的名称及签名。
 *
 * @var string
 */
 protected $signature = 'email:send
                 {user : The ID of the user}
                 {--queue= : Whether the job should be queued}';

und argument verwenden, um das Ziel zu erreichen: option

/**
 * 执行命令。
 *
 * @return mixed
 */
 public function handle(){
     $userId = $this->argument('user');    
     //
 }

-Array erhalten werden, können Sie die Methode array aufrufen: arguments

$arguments = $this->arguments();

problemlos den Wert der Option abrufen. Um alle Optionen als Array abzurufen, verwenden Sie die Methode option: options

// 获取一个指定的选项值
$queueName = $this->option('queue');
// 获取所有的选项值
$options = $this->options();

zurück. null

/**
 * 执行命令。
 *
 * @return mixed
 */
 public function handle(){
     $name = $this->ask('What is your name?');
 }

$password = $this->secret('What is the password?');

if ($this->confirm('Do you wish to continue?')) {
    //
 }

$name = $this->anticipate('What is your name?', ['Taylor', 'Dayle']);

$name = $this->choice('What is your name?', ['Taylor', 'Dayle'], $defaultIndex);

/**
 * 执行命令。
 *
 * @return mixed
 */
 public function handle(){
     $this->info('Display this on the screen');
 }

$this->error('Something went wrong!');

$this->line('Display this on the screen');

$headers = ['Name', 'Email'];
$users = App\User::all(['name', 'email'])->toArray();
$this->table($headers, $users);

$users = App\User::all();
$bar = $this->output->createProgressBar(count($users));
$bar->start();foreach ($users as $user) { 
   $this->performTask($user);    
   $bar->advance();
}$bar->finish();

/**
 * 注册应用的命令
 *
 * @return void
 */
 protected function commands(){ 
    $this->load(__DIR__.'/Commands');    
    $this->load(__DIR__.'/MoreCommands'); 
   // ...
}

protected $commands = [ 
   Commands\SendEmails::class
  ];

Route::get('/foo', function () { 
   $exitCode = Artisan::call('email:send', [  
         'user' => 1,
          '--queue' => 'default' 
       ]);  
     //
 });

Artisan::call('email:send 1 --queue=default');

Route::get('/foo', function () { 
   Artisan::queue('email:send', [   
        'user' => 1,
         '--queue' => 'default' 
        ]); 
      //
});

Artisan::queue('email:send', [ 
   'user' => 1, 
   '--queue' => 'default'
 ])->onConnection('redis')->onQueue('commands');

Route::get('/foo', function () { 
   $exitCode = Artisan::call('email:send', [    
       'user' => 1,
        '--id' => [5, 13]   
      ]);
 });

$exitCode = Artisan::call('migrate:refresh', [
    '--force' => true,
  ]);

/**
 * 执行控制台命令
 *
 * @return mixed
 */
 public function handle(){ 
    $this->call('email:send', [   
         'user' => 1, 
         '--queue' => 'default' 
      ]); 
      //
 }

$this->callSilent('email:send', [ 
   'user' => 1, 
   '--queue' => 'default'
 ]);