Laravel - アーティザン コンソール

Laravel フレームワークは、コマンドラインを介した対話のための 3 つの主要なツール、つまり Artisan、Ticker、および REPL を提供します。この章ではArtisanについて詳しく説明します

職人のご紹介

Artisan は Laravel で頻繁に使用されるコマンドライン インターフェイスであり、Web アプリケーションの開発に役立つ一連のコマンドが含まれています。

例

これは、Artisan のいくつかのコマンドとそれぞれの機能のリストです -

Laravelプロジェクトを開始するには

php artisan serve

キャッシュメカニズムを有効にするには

php artisan route:cache

Artisan でサポートされている使用可能なコマンドのリストを表示するには

php artisan list

コマンドに関するヘルプを表示し、使用可能なオプションと引数を表示するには

php artisan help serve

次のスクリーンショットは、上記のコマンドの出力を示しています -

コマンドの作成

Artisan にリストされているコマンドに加えて、ユーザーは Web アプリケーションで使用できるカスタム コマンドを作成することもできます。コマンドは app/console/commands ディレクトリ に保存されることに注意してください。

ユーザー定義コマンドを作成するためのデフォルトのコマンドを以下に示します -

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

上記のコマンドを入力すると、以下のスクリーンショットに示すような出力が表示されます -

DefaultCommand

用に作成されたファイルはDefaultCommand.phpという名前で、以下に示されています -

<?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() {
      //
   }
}

このファイルには、ユーザーが定義したコマンドの署名と説明が含まれています。

handle

という名前のパブリック関数は、コマンドの実行時に機能を実行します。これらのコマンドは、同じディレクトリ内のファイル Kernel.php に登録されます。次のコードに示すように、ユーザー定義コマンドのタスクのスケジュールを作成することもできます -

<?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();
   }
}

指定されたコマンドのタスクのスケジュールは、

schedule

という名前の関数で定義されていることに注意してください。これには、

hourlyパラメータを受け取るタスクをスケジュールするためのパラメータが含まれています。コマンドは、コマンドのパスと名前を含むコマンドの配列に登録されます。コマンドが登録されると、アーティザンコマンドにリストされます。署名と説明セクションに含まれる値は、指定したコマンドの help 属性を呼び出すと表示されます。

コマンド

DefaultCommand

の属性を表示する方法を見てみましょう。以下に示すようにコマンドを使用する必要があります-

php artisan help DefaultCommand

以上がLaravel - アーティザン コンソールの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。