آموزش کار با Artisan Console در Laravel لاراول

فریمورک Laravel برای تعامل از طریق خط فرمان، سه ابزار اصلی را فراهم کرده است: Artisan، Ticker و REPL.

معرفی artisan

در این بخش درمورد جزئیات Artisan توضیح خواهیم داد. Artisan یک رابط خط فرمان(Interface Command-line) است، که اغلب در Laravel استفاده می شود و شامل مجموعه ای از دستورات مفید، برای ایجاد یک برنامه وب می باشد.

مثال

در اینجا لیستی از چند دستور در Artisan همراه با ویژگی های مربوط به آنها را بیان می کنیم.

■ برای شروع پروژه لاراول دستور زیر را وارد می کنیم. به وسیله این دستور می توانیم، بدون اینکه برنامه wamp یا xamp را روی سیستم فعال کرده باشیم، سایت خود را به صورت local در مرورگر اجرا کنیم.

php artisan serve

■ برای فعال کردن مکانیزم ذخیره سازی (caching)، از این دستور استفاده می کنیم .

php artisan route:cache

■ برای مشاهده فهرست دستورات موجود که توسط Artisan پشتیبانی می شوند، از دستور زیر استفاده می کنیم .

php artisan list

■ برای دیدن help در مورد هر دستور و option های موجود (available options) و آرگومان های دستور، از فرمان زیر استفاده می کنیم.

php artisan help serve

تصویر زیر، خروجی دستورات داده شده در بالا را نشان می دهد :

نوشتن دستورات سفارشی

یک کاربر علاوه بر دستورات ذکر شده در Artisan، همچنین می تواند یک دستور سفارشی ایجاد کند و به مجموعه دستورات artisan اضافه نماید، تا در برنامه های وب مورد استفاده قرار گیرد. این دستورات در دایرکتوری app/console/commands ذخیره می شوند.

فرمان پیش فرض برای ایجاد دستوراتی که توسط کاربر تعریف می شود، در زیر نشان داده شده است.

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

هنگامی که فرمان فوق را تایپ می کنید، خروجی مطابق با تصویر زیر، برای شما نمایش داده خواهد شد.

با اجرا نمودن دستور بالایی، یک فایل به نام DefaultCommand.php در دایرکتوری app/Console/Commands ایجاد می شود. ساختار کلی این فایل به شکل زیر می باشد.

<?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 = 'command:name';
   
   /**
      * 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(){
      //
   }
}

این فایل شامل  دو پراپرتی signature$ و description$ برای فرمان (command ) است که توسط کاربر مقدار دهی می شود. 

در پراپرتی signature$  نام دستور را وارد می کنیم و اگر دستور ما دارای آرگومان بود، آرگومان های آن را نیز می نویسیم. و اگر دستور دارای option بود آنها را نیز قرار می دهیم. آرگومان ها را باید داخل آکولاد قرار دهیم و option ها را با دو کاراکتر dash یا خط تیره (--) مشخص می کنیم.

protected $signature = 'command:name {argument}';

در پراپرتی description$  توضیحات مربوط به دستور را وارد می کنیم .

protected $description = 'Command description';

همچنین این فایل، شامل تابع عمومی به نام handle  است، که عملیاتی که می خواهیم برای دستور اجرا شود را در آن قسمت می نویسیم.

public function handle(){
      //

}

در انتها برای اینکه این دستورجدیدمان را به دستورات Artisan بیفزاییم، باید وارد کلاس app/Console/Kernel.php شویم و به آرایه commands$ کلاس DefaultCommand که ساخته ایم را اضافه نماییم.

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

شما همچنین می توانید برای دستوری که ایجاد کرده ایم، برنامه ی وظایف (schedule of tasks) تعریف کنید. همانطور که در کد زیر نشان داده شده است.

<?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's command schedule.
      *
      * @param \Illuminate\Console\Scheduling\Schedule $schedule
      * @return void
   */
   
   protected function schedule(Schedule $schedule){
      // $schedule->command('inspire')
      // ->hourly();
   }
}

توجه داشته باشید که برنامه وظایف  (schedule of tasks) برای دستور داده شده ، در تابع schedule تعریف می شوند، که شامل یک پارامتر به نام hourly ، برای برنامه ریزی وظایف است .

هر دستور artisan در آرایه ای از دستورات ثبت شده است. که شامل مسیر (path) دستور و نام دستور است. هنگامی که دستوری به دستورات artisan اضافه می شود، آن دستور در لیست دستورات artisan قرارمی گیرد.

هنگامی که دستور artisan رو همراه با کلمه help می آورید، مقادیری که در قسمت امضا(signature) و توضیحات (description) وجود دارند، قابل مشاهده هستند.

به عنوان مثال اگر ما بخواهیم attributeهای دستور  DefaultCommandی که ساخته ایم را مشاهده کنیم، باید از دستور artisan زیر در خط فرمان استفاده کنیم :

php artisan help DefaultCommand