Artisanコンソール

php artisan list

php artisan help migrate

php artisan tinker

// ユーザーを取得して確認
>>> App\Models\User::find(1)
// ファクトリでレコードを作成
>>> App\Models\User::factory()->create()
// サービスクラスを直接呼び出す
>>> app(App\Services\OrderService::class)->process(1)

php artisan make:command ImportProducts

<?php

namespace App\Console\Commands;

use Illuminate\Console\Command;

class ImportProducts extends Command
{
    /**
     * コマンド名と引数・オプションの定義
     */
    protected $signature = 'import:products';

    /**
     * コマンドの説明(php artisan list に表示される)
     */
    protected $description = '商品データをCSVからインポートする';

    /**
     * コマンドの実行処理
     */
    public function handle(): void
    {
        $this->info('インポートを開始します...');
        // 処理を記述する
        $this->info('完了しました。');
    }
}

protected $signature = 'import:products
                        {file : インポートするCSVファイルのパス}
                        {--limit= : インポートする最大件数}
                        {--dry-run : 実際にはDBに保存しない(確認用)}';

public function handle(): void
{
    $file    = $this->argument('file');       // 引数の取得
    $limit   = $this->option('limit');        // オプションの取得
    $dryRun  = $this->option('dry-run');      // フラグオプション(bool)

    $this->info("ファイル: {$file}");

    if ($dryRun) {
        $this->warn('ドライランモード: DBへの保存はスキップします');
    }
}

$this->info('処理が正常に完了しました');    // 緑
$this->warn('この操作は元に戻せません');    // 黄
$this->error('エラーが発生しました');       // 赤
$this->line('通常のテキスト');             // 色なし
$this->comment('補足情報');               // 薄いグレー

// テキスト入力
$name = $this->ask('担当者名を入力してください');

// デフォルト値付き
$env = $this->ask('実行環境を選択', 'production');

// パスワードなど秘匿情報(入力が画面に表示されない)
$password = $this->secret('APIキーを入力してください');

// Yes/No確認
if (! $this->confirm('本番DBにインポートしますか？')) {
    $this->info('キャンセルしました。');
    return;
}

// 選択肢から選ぶ
$format = $this->choice('出力形式を選んでください', ['csv', 'json', 'xml'], 0);

use App\Models\Product;

// コレクションを渡すだけで自動的にプログレスバーを表示する
$this->withProgressBar(Product::cursor(), function (Product $product) {
    $this->processProduct($product);
});

$total = Product::count();
$bar = $this->output->createProgressBar($total);
$bar->start();

Product::cursor()->each(function (Product $product) use ($bar) {
    $this->processProduct($product);
    $bar->advance();
});

$bar->finish();
$this->newLine();

<?php

namespace App\Console\Commands;

use App\Models\Order;
use Illuminate\Console\Command;

class PruneOldOrders extends Command
{
    protected $signature = 'orders:prune {--days=90 : 何日前より古いデータを削除するか}';

    protected $description = '指定日数より古い完了済み注文を削除する';

    public function handle(): void
    {
        $days = (int) $this->option('days');

        if (! $this->confirm("{$days}日以上前の完了済み注文を削除しますか？")) {
            $this->info('キャンセルしました。');
            return;
        }

        $deleted = Order::where('status', 'completed')
            ->where('created_at', '<', now()->subDays($days))
            ->delete();

        $this->info("{$deleted} 件の注文データを削除しました。");
    }
}

use Illuminate\Support\Facades\Schedule;

// 毎日深夜2時に実行
Schedule::command('orders:prune --days=90')->dailyAt('2:00');

// 毎週月曜9時に実行
Schedule::command('import:products storage/weekly.csv')->weeklyOn(1, '9:00');

<?php

namespace Tests\Feature\Commands;

use App\Models\Order;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Tests\TestCase;

class PruneOldOrdersTest extends TestCase
{
    use RefreshDatabase;

    public function test_it_deletes_old_completed_orders(): void
    {
        // 90日以上前の完了済み注文を作成
        Order::factory()->create([
            'status'     => 'completed',
            'created_at' => now()->subDays(100),
        ]);

        // 直近の完了済み注文(削除されないはず)
        Order::factory()->create([
            'status'     => 'completed',
            'created_at' => now()->subDays(10),
        ]);

        $this->artisan('orders:prune', ['--days' => 90])
            ->expectsConfirmation('90日以上前の完了済み注文を削除しますか？', 'yes')
            ->expectsOutput('1 件の注文データを削除しました。')
            ->assertExitCode(0);

        $this->assertDatabaseCount('orders', 1);
    }

    public function test_it_cancels_when_user_declines(): void
    {
        Order::factory()->create(['status' => 'completed', 'created_at' => now()->subDays(100)]);

        $this->artisan('orders:prune', ['--days' => 90])
            ->expectsConfirmation('90日以上前の完了済み注文を削除しますか？', 'no')
            ->expectsOutput('キャンセルしました。')
            ->assertExitCode(0);

        $this->assertDatabaseCount('orders', 1);
    }
}

# コマンドを新規作成
php artisan make:command CommandName

# 利用可能なコマンド一覧
php artisan list

# コマンドの使い方を確認
php artisan help command:name

# Tinkerを起動
php artisan tinker