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에의 저장은 스킵합니다');
    }
}

use App\Enums\ReportType;

public function handle(): void
{
    // 인수·옵션을 CommandInput 인스턴스로 취득
    $from = $this->input()->date('from');
    $type = $this->input()->enum('type', ReportType::class);
    $limit = $this->input()->integer('limit');
}

$queue = $this->input('queue', 'default');

$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