laravel-query-builders

Laravel クエリビルダー

ローカルスコープではなく、必ずカスタムクエリビルダーを使用してください。

関連ガイド：

• モデル - カスタムビルダーとのモデル連携
• コントローラー - コントローラーでのクエリオブジェクトの使用

スコープよりもカスタムビルダーを使う理由

❌ ローカルスコープは使用しないでください。

✅ カスタムクエリビルダーを使用してください。以下の利点があります：

1. 型ヒントが充実 - IDE の自動補完を完全に利用できます
2. 型安全なネストクエリ - whereHas()、orWhereHas() などでクロージャに型ヒントを指定できます
3. 整理しやすい - すべてのクエリロジックを 1 つのクラスにまとめられます
4. 合成しやすい - チェーンや合成を簡単に行えます
5. テストしやすい - クエリロジックを分離してテストできます

基本的なビルダーの構造

<?php

declare(strict_types=1);

namespace App\Builders;

use App\Enums\OrderStatus;
use App\Models\User;
use Carbon\Carbon;
use Illuminate\Database\Eloquent\Builder;

class OrderBuilder extends Builder
{
    public function wherePending(): self
    {
        return $this->where('status', OrderStatus::Pending);
    }

    public function whereCompleted(): self
    {
        return $this->where('status', OrderStatus::Completed);
    }

    public function whereCustomer(User|int $customer): self
    {
        $customerId = $customer instanceof User ? $customer->id : $customer;
        return $this->where('customer_id', $customerId);
    }

    public function whereTotalGreaterThan(int $amount): self
    {
        return $this->where('total', '>', $amount);
    }

    public function wherePlacedBetween(Carbon $start, Carbon $end): self
    {
        return $this->whereBetween('placed_at', [$start, $end]);
    }

    public function withRelated(): self
    {
        return $this->with(['customer', 'items.product', 'shipments']);
    }

    public function recent(): self
    {
        return $this->latest('placed_at');
    }
}

型安全なネストクエリ

リレーションシップクエリで IDE のサポートを完全に利用するには、クロージャに型ヒントを指定します。

public function whereHasItems(array|string $productIds): self
{
    return $this->whereHas('items', function (OrderItemBuilder $query) use ($productIds): void {
        $query->whereIn('product_id', (array) $productIds);
    });
}

使用方法：

Order::query()
    ->whereHas('items', function (OrderItemBuilder $query): void {
        $query->whereActive()        // Custom method - autocomplete works!
              ->whereProduct($id);   // Full type safety!
    })
    ->whereHas('customer', function (CustomerBuilder $query): void {
        $query->whereVerified()      // Custom method
              ->wherePremium();      // IDE knows all methods!
    })
    ->get();

外部メソッドの PHPDoc

Spatie パッケージやマクロのメソッドをドキュメント化します。

/**
 * @method static OrderBuilder whereState(string $column, string|array $state)
 * @method static OrderBuilder whereNotState(string $column, string|array $state)
 */
class OrderBuilder extends Builder
{
    // ...
}

ビルダートレイト

再利用可能なクエリロジックを切り出します。

<?php

declare(strict_types=1);

namespace App\Builders\Concerns;

use Illuminate\Support\Arr;

trait HasProducts
{
    public function whereHasProducts(array|string $productIds): self
    {
        return $this->whereHas('products', function ($query) use ($productIds): void {
            $query->whereIn('id', Arr::wrap($productIds));
        });
    }

    public function whereHasActiveProducts(): self
    {
        return $this->whereHas('products', function ($query): void {
            $query->where('active', true);
        });
    }
}

ビルダーでの使用方法：

class OrderBuilder extends Builder
{
    use HasProducts;

    // ...
}

モデルへのビルダーの登録

推奨：PHP 属性（Laravel 12 以降）

use Illuminate\Database\Eloquent\Attributes\UseEloquentBuilder;

#[UseEloquentBuilder(OrderBuilder::class)]
class Order extends Model
{
    // ...
}

代替方法：メソッドのオーバーライド（Laravel 12 より前）

public function newEloquentBuilder($query): OrderBuilder
{
    return new OrderBuilder($query);
}

使用例

基本的なチェーン

Order::query()
    ->wherePending()
    ->whereTotalGreaterThan(10000)
    ->wherePlacedBetween(now()->subWeek(), now())
    ->withRelated()
    ->recent()
    ->paginate();

遅延イテレーション

Order::query()
    ->whereCompleted()
    ->lazyById()
    ->each(function (Order $order): void {
        // Process order
    });

複雑なクエリ

$orders = Order::query()
    ->wherePending()
    ->whereCustomer($user)
    ->whereHasItems([$productId1, $productId2])
    ->wherePlacedBetween($startDate, $endDate)
    ->withRelated()
    ->get();

空のビルダー

将来的な拡張に備え、最初は空であっても必ずビルダーを作成してください。

<?php

declare(strict_types=1);

namespace App\Builders;

use Illuminate\Database\Eloquent\Builder;

class CustomerBuilder extends Builder
{
    // Empty for now, but ready for future methods
}

よく使うビルダーメソッド

ステータスによるフィルタリング

public function whereActive(): self
{
    return $this->where('status', 'active');
}

public function whereInactive(): self
{
    return $this->where('status', 'inactive');
}

日付範囲

public function whereCreatedAfter(Carbon $date): self
{
    return $this->where('created_at', '>', $date);
}

public function whereCreatedToday(): self
{
    return $this->whereDate('created_at', today());
}

ユーザー／所有者によるフィルタリング

public function whereUser(User|int $user): self
{
    $userId = $user instanceof User ? $user->id : $user;
    return $this->where('user_id', $userId);
}

リレーションシップの読み込み

public function withFullRelations(): self
{
    return $this->with([
        'user',
        'items.product',
        'customer.address',
    ]);
}

ビルダーの構成

app/Builders/
├── OrderBuilder.php
├── CustomerBuilder.php
├── ProductBuilder.php
└── Concerns/
    ├── HasProducts.php
    ├── HasDates.php
    └── HasStatus.php