ایجاد دستور اختصاصی برای artisan در لاراول

/ مرداد ۱۸, ۱۳۹۶ / بدون دیدگاه / در آموزش - لاراول / توسط

در این مقاله کوتاه می خواهیم روش ایجاد دستور جدید برای artisan را در لاراول ۵ بررسی کنیم.

روش کار

برای ایجاد یک دستور جدید ابتدا به سراغ Terminal رفته و دستور زیر را تایپ می کنیم .

php artisan make:command HealthcheckCommand 

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

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

<?php

namespace App\Console\Commands;

use Illuminate\Console\Command;

class HealthcheckCommand extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'healthcheck
                            {url : The URL to check}
                            {status=200 : The expected status code}';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Runs an HTTP healthcheck to verify the endpoint is available';

    /**
     * Create a new command instance.
     *
     * @return void
     */
    public function __construct()
    {
        parent::__construct();
    }

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

در این فایل متغیر signature$ اسم دستور و description$ توضیحات مربوط به آن را مشخص می کند . این توضیحات در Terminal  نمایش داده خواهد شد .

در متد handle هم می توانید کاری که قرار است این دستور انجام دهد را مشخص کنید.

خط تقریبا کار تمام شد .

فقط کافیست این فایل را به کرنل معرفی کنیم. برای این کار فایل app/Console/Kernel.php رو باز و این خط را به بخش دستورات اضافه کنید :

protected $commands = [
    Commands\HealthcheckCommand::class,
];

حالا دستور artisan help healthcheck را اجرا کنید. اگه همه مراحل را درست انجام داده باشید باید خروجی مثل تصویر زیر مشاهده کنید .

نوشته های مرتبط

ارسال دیدگاه

نشانی ایمیل شما منتشر نخواهد شد. بخش‌های موردنیاز علامت‌گذاری شده‌اند *