Laravel で便利なメソッド集

はじめに

Laravel には開発を効率化する便利なメソッドが多数用意されています。本記事では、よく使う便利なメソッドをピックアップして紹介します。

---

1. pluck() - 特定のカラムの値を取得

pluck() を使うと、コレクションやクエリの結果から特定のカラムのみを簡単に取得できます。

使用例

$names = User::pluck('name');
// ["Alice", "Bob", "Charlie"]

第二引数を指定すると、キーと値のペアを取得できます。

$users = User::pluck('name', 'id');
// [1 => "Alice", 2 => "Bob", 3 => "Charlie"]

---

2. whereIn() - 指定した複数の値を検索

whereIn() を使うと、特定のカラムが指定した配列の値と一致するレコードを取得できます。

使用例

$users = User::whereIn('id', [1, 2, 3])->get();

逆に whereNotIn() を使うと、指定した値以外のレコードを取得できます。

$users = User::whereNotIn('id', [1, 2, 3])->get();

---

3. when() - 条件付きでクエリを適用

when() を使うと、条件に応じてクエリを適用することができます。

使用例

$query = User::query();

$search = 'Alice';
$query->when($search, function ($q, $search) {
    return $q->where('name', 'like', "%{$search}%");
});

$users = $query->get();

---

4. firstOrCreate() - 存在しなければ作成

firstOrCreate() を使うと、指定の条件でデータを検索し、存在しなければ新規作成できます。

使用例

$user = User::firstOrCreate([
    'email' => '[e-mail]'
], [
    'name' => 'New User'
]);

類似メソッドとして firstOrNew() もあり、こちらは新規作成時に save() を明示的に呼ぶ必要があります。

$user = User::firstOrNew(['email' => '[e-mail]']);
$user->name = 'New User';
$user->save();

---

5. updateOrCreate() - 更新または作成

updateOrCreate() を使うと、指定の条件でレコードを検索し、存在すれば更新、なければ作成できます。

使用例

$user = User::updateOrCreate(
    ['email' => '[e-mail]'],
    ['name' => 'Updated Name']
);

---

6. exists() - レコードの存在確認

特定の条件に一致するレコードが存在するかどうかを exists() で確認できます。

使用例

if (User::where('email', '[e-mail]')->exists()) {
    echo "User exists!";
}

逆に doesntExist() を使うと、存在しない場合のチェックができます。

if (User::where('email', '[e-mail]')->doesntExist()) {
    echo "User does not exist!";
}

---

7. chunk() - 大量データを効率的に処理

chunk() を使うと、大量のデータを小分けにして処理できます。

使用例

User::chunk(100, function ($users) {
    foreach ($users as $user) {
        // ユーザーデータを処理
    }
});

---

8. tap() - オブジェクトを変更しつつ返す

tap() を使うと、メソッドチェーンの途中でオブジェクトを操作できます。

使用例

$user = tap(User::find(1), function ($user) {
    $user->update(['name' => 'Updated Name']);
});

---

9. collect() - 配列をコレクションに変換

collect() を使うと、配列を便利なコレクションオブジェクトに変換できます。

使用例

$collection = collect([1, 2, 3, 4, 5]);

$filtered = $collection->filter(function ($value) {
    return $value > 2;
});

print_r($filtered->all()); // [3, 4, 5]

---

まとめ

Laravel には開発を効率化する多くの便利なメソッドがあります。本記事で紹介したメソッドを活用することで、コードをシンプルにし、可読性や保守性を向上させることができます。

ぜひ、日々の開発に役立ててください！