laravel8

フレームワークで開発してると、「このfunction本当に挙動あってる？」みたいな瞬間があると思います。（あるよね？）

それを確認するためにTest作れとかいう意見もわかるんですが、そもそもそのテストを作るためにちょっと挙動を確認したいときもあるわけです。

laravelでいうtinkerみたいな対話式プログラムも用意されていますが、僕的にはコマンドラインで echo “hello world”;　以上のことやるの難しいと思うんですよね。

Web出力にvar_dumpとかするにしても、都合の良いページがあればいいですが、var_dumpするためにいちいちコントローラーとか作るのもめんどくさいわけです。

だから僕はそんなときは、コマンドラインプログラムで対応しています。

なので今回はlaravelでコマンドラインプログラム実装する備忘録。

環境

Laravel8、php7、Laravel Sail

やりたいこと

laravelのコマンドラインプログラムでHello Worldを出力する。

まずはCommandファイルを作成

sail artisan make:command Kirin

これで/app/Console/Commands/Kirin.phpが作られる。

Sail未導入ならsail -> phpに置き換えかな

Kirin.phpを修正

直すところは大まかに3つ、$signature、$descripitionとhandle()の中身です。

<?php

namespace App\Console\Commands;

use Illuminate\Console\Command;

class Kirin extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
//  コマンド文字列を指定
    protected $signature = 'kirin:test';

    /**
     * The console command description.
     *
     * @var string
     */
//  コマンドの説明（適当でOK）
    protected $description = '頑張って作ったコマンドラインプログラム';

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

    /**
     * Execute the console command.
     *
     * @return int
     */
    public function handle()
    {
//      ここに処理を記述
        echo 'Hello world.' . PHP_EOL;
        return Command::SUCCESS;
    }
}

実行

以下のコマンドを実行します。

$ php artisan kirin:test

$php artisan + $signatureで指定した文字列

実行結果

Hello world.

まとめ

Laravelの場合、useやらnamespaceやら色々プログラムを動かすために記述が必要で、こんなのIDEが無いと無理。

コマンドラインプログラムにしておけば、IDEで保管しながらコーディングできるしモデルとか使う場合とかこういうふうにしないとわけわかんなくね？

というひとのためのtipsです。