Laravel Spatie Query Builder - 为过滤器创建 OR 条件

Question

I am using laravel spatie for filtering the model i have following filters in allowed filter array

$this->allowedFilters = [
        'name',
        AllowedFilter::exact('company_id'),
        'location',
        'summary',
        'client_name',
    ];

when I make request like

past-projects?filter[company_id]=${companyId}&filter[name]=${search}&filter[summary]={company_id}

it searches for the data which exactly contains all the passed search params with AND condition and returns no results if any of passed param do not match. I want to get results if any of the passed param match.

Any help will be appreciated.

Answer 1

As per Spatie Laravel Query Builder documentation the allowedFilters() method will take the array of strings and return a result where all the parameters match.

The bad news: Therefore, it will not work as how you are intending to use it.

What you want is Laravel's Or Where Clause .

The good news: since Spatie Laravel Query Builder extends Laravel's default Eloquent query builder you can use both Laravel queries and Spatie queries in conjunction.

---

Say you want to get all users from "Org ABC" and from that result you want to get all users with either the name "Jack" or the location "USA" or the client_name "John" or the summary "Hello World". Then you can try

$result = QueryBuilder::for(Projects::class)
          ->allowedFilters(['company_id']
          ->where(function ($query) use ($name, $location, ...)
                $query
                    ->where('projects.user.name', 'like', '%$title%')
                    ->orWhere('projects.location', 'like', '%$location%')
                    ->orWhere() ....
          );

return $result

---

Answer 2

I came across this issue... Here's a way I resolved it. You could also use the callback in the query builder like this...

$users = QueryBuilder::for(User::class)
->allowedFilters([
'user_type',
'user_city',
AllowedFilter::exact('status')->default('new'),
AllowedFilter::callback('search', function($query, $value){
    $query->where('name', 'LIKE', '%' . $value . '%')
    ->orWhere('bio', 'LIKE', '%' . $value . '%')
    ->orWhere('state', 'LIKE', '%' . $value . '%')
    ->orWhere('address', 'LIKE', '%' . $value . '%');
})
])->get();

then the URL will look like this for example

?filter[user_type]=customer&filter[search]=doe&filter[user_city]=boston

The search parameter will be used to check the name, bio, state and address for any match.