Laravel Eloquent Builder Macro: phù phép whereLike trong dự án thực tế

Vẽ vời một chút

Trong project thực tế chuyện tìm kiếm thứ gì đó trong database bằng LIKE xảy ra như cơm bữa.

Ví dụ tìm về bảng users với Model là User nha

User::query()
   ->where('name', 'LIKE', "%{$searchTerm}%") 
   ->orWhere('email', 'LIKE', "%{$searchTerm}%") 
   ->get();

Và bạn sẽ còn tìm ở nhiều nơi nữa, Post, Comment, Category, Tag, ... và bạn chán ngấy giống như mấy thằng sở khanh nó ngấy con ghẹ của nó trong khi bạn vẫn FA =)) vậy thì đổi cơn gió mùa xem sao

Sử dụng Laravel Eloquent Builder Macro

Bạn hãy mở App\Providers\AppServiceProvider lên, trong function boot() thêm đoạn này vào

use Illuminate\Database\Eloquent\Builder;

// ...

Builder::macro('whereLike', function(string $attribute, string $searchTerm) {
   return $this->orWhere($attribute, 'LIKE', "%{$searchTerm}%");
});

Với đoạn search ở trên bạn có thể dễ dàng viết lại

User::query()
   ->whereLike('name', $searchTerm)
   ->whereLike('name', $searchTerm)
   ->get();

Ơ khoan, cải tiến một chút...

Nếu như viết ở trên thì có mẹ gì đâu mà phải vẽ vời đúng không nào =))

Bạn sẽ cần search nhiều field với một dữ liệu đầu vào là searchTeam, ta viết lại đoạn macro

Builder::macro('whereLike', function($attributes, string $searchTerm) {
   foreach(array_wrap($attributes) as $attribute) {
      $this->orWhere($attribute, 'LIKE', "%{$searchTerm}%");
   }
   
   return $this;
});

array_wrap quả thật là một nice helper, bạn nạp vào array nó trả về array, bạn nạp vào string nó cũng trả về array, và lặp, không phải ngại.

Vậy đoạn search ở trên được viết lại như sau

// search một field
User::whereLike('name', $searchTerm)->get();

// search nhiều field
User::whereLike(['name', 'email'], $searchTerm)->get();

Chờ một chút, có bug đấy 👻

Bạn định tìm kiếm một user có role là admin và name hoặc email là chung, à ha nhanh chóng bạn sẽ viết ngay

User::query()
   ->where('role', 'admin')
   ->whereLike(['name', 'email'], 'chung')
   ->get();

À ha, cuộc đời bạn sẽ ngập ngụa trong bug ngay 💩💩 where ở trên sử dụng AND, whereLike sử dụng OR, và chẳng khác gì bạn tự SQL Injection chính mình đâu.

Cải tiến chút nữa coi ~

Builder::macro('whereLike', function ($attributes, string $searchTerm) {
    $this->where(function (Builder $query) use ($attributes, $searchTerm) {
        foreach (array_wrap($attributes) as $attribute) {
            $query->orWhere($attribute, 'LIKE', "%{$searchTerm}%");
        }
    });

    return $this;
});

Đấy ~ bạn nào giỏi tìm ra bug coi 😁😁

Đừng tự mãn thế chứ, làm gì cho ngầu chút đi 🙄🤔🤔

Hỗ trợ search các bảng quan hệ

Talk is cheap, show me the code, OK

Builder::macro('whereLike', function ($attributes, string $searchTerm) {
    $this->where(function (Builder $query) use ($attributes, $searchTerm) {
        foreach (array_wrap($attributes) as $attribute) {
            $query->when(
                str_contains($attribute, '.'),
                function (Builder $query) use ($attribute, $searchTerm) {
                    [$relationName, $relationAttribute] = explode('.', $attribute);

                    $query->orWhereHas($relationName, function (Builder $query) use ($relationAttribute, $searchTerm) {
                        $query->where($relationAttribute, 'LIKE', "%{$searchTerm}%");
                    });
                },
                function (Builder $query) use ($attribute, $searchTerm) {
                    $query->orWhere($attribute, 'LIKE', "%{$searchTerm}%");
                }
            );
        }
    });

    return $this;
});

Giờ thì bạn có thể search cả relation, ví dụ tìm một bài post mà keyword có thể là name, text (content), tên tác giả, tags có trong bài viết đó

Post::whereLike(['name', 'text', 'author.name', 'tags.name'], $searchTerm)->get();

Hết rồi ~ rảnh đọc kết chơi

Kết

Đọc tới đây hẳn bạn sẽ thấy ghen tị với Chung phải không, dễ hiểu mà độ đệp trai thanh lịch của Chung mấy ai mà không sinh lòng ganh ghét cơ chứ 😄😄😁 - có gì đó sai nhưng mà thôi, bỏ qua đi. Bài viết lấy nguồn từ murze.be được Chung - (đáng lẽ ra là nhà văn nổi tiếng nhưng vì bố mẹ bắt đi lập trình) dịch và thêm muối cho vừa miệng

🎁🎁 💎 🎁🎁