چطور یک دستور جدید به artisan اضافه کنیم؟

با سلام خدمت دوستان و همراهان سایت چسبون. در این آموزش قصد داریم نحوه اضافه کردن دستور جدید به Artisan در لاراول را آموزش دهیم.

وارد ترمینال شده و دستور زیر را تایپ کنید:

php artisan list

بدین ترتیب لیست تمام دستورات artisan به نمایش در می آید. اگر می خواهید شما هم یک دستور جدید به این لیست اضافه کنید می توانید از دستور make لاراول استفاده کنید. این فرمان ساختار کلی دستور مورد نظر برای شما ایجاد می کند که می توانید تغییرات مورد نظر خود را در آن اعمال نمایید. با ما همراه باشید:

ابتدا دستور زیر را اجرا کنید:

php artisan make:command QuizStart --command=quiz:start

در صورتیکه دستور را به درستی تایپ کرده باشید، پیغام ایجاد موفقیت آمیز دستور به شما نمایش داده می شود. این دستور یک فایل با نام QuizStart.php (نامی که شما برای دستور وارد کرده اید) در مسیر app/Console/Commands ایجاد می کند. ساختار کلی این فایل به شکل زیر می باشد:

<?php 
namespace App\Console\Commands;
use Illuminate\Console\Command;

  class QuizStart extends Command { 
  /**
   * The name and signature of the console command. 
   * 
   * @var string 
   */

    protected $signature = 'quiz:start'; 
    /** 
    * The console command description. * 
    * @var string 
    */ 

    protected $description = 'Command description'; 
    /** 
    * Create a new command instance. * 
    * @return void 
    */ 

    public function __construct() { 
        parent::__construct(); 
    } 
    /** 
    * Execute the console command. * 
    * @return mixed 
    */ 
    public function handle() { 
      // 
    } 
}

شما می توانید این فایل را ویرایش نمایید و دستورات مورد نظر خود را در متد ()handle اضافه کنید. جهت نمایش پیغام در ترمینال نیز می توانید از متد های زیر استفاده کنید:

public function handle() { 
	$this->line("Some text"); 
	$this->info("Hey, watch this !"); 
	$this->comment("Just a comment passing by"); 
	$this->question("Why did you do that?"); 
	$this->error("Ops, that should not happen."); 
}

بعد از نوشتن کدهای مورد نظر و ذخیره فایل، باید این دستور را به artisan معرفی کنید. جهت ثبت دستور ساخته شده فایل kernel.php موجود در مسیر app/Console را باز کنید. نام کلاس دستور خود را در بخش commands بنویسید:

protected $commands = [ 
        'App\Console\Commands\QuizStart' 
];

کافیست تا دستور زیر را در ترمینال/CMD اجرا کنید:

php artisan cache:clear

خب تبریک میگم، دستور ساخته شده به لیست دستورات artisan اضافه شد. یکبار دیگر دستور php artisan list را اجرا کنید تا نتیجه کار را ببینید.

چسبون مرجع برنامه نویسی و وب.