Как организовать опциональное условие в запросе?

Question

[lexstile]

Эндпоинт - получение списка сотрудников.
Приходит роль (опционально), если не приходит - возвращаем всех.
Как правильно организовать подобный кейс и какие есть подводные камни?

Я пока написал так:

public function getEmployees(Request $request, Project $project)
    {
        $role = $request->get('role');
        $users = $project->users();

        if (in_array($role, [User::USER, User::ADMIN])) {
            $users->where('role', '=', $role);
        }

        return UserResource::collection($users->orderBy('id', 'desc')->paginate(request('limit', 10)));
    }

Comments

[Дмитрий]

В доке гляньте метод when() у билдера

[Дмитрий]

https://laravel.com/docs/9.x/queries#conditional-c...

[JhaoDa]

Дмитрий, спасибо, Гугл-джан!

[JhaoDa]

Автор, документация — твой лучший друг. Но ты в это не веришь и игноришь её...

[lexstile]

Дмитрий, благодарю, похоже тут логичнее использовать еще и scope.

public function getEmployees(Request $request, Project $project)
    {
        $users = $project->users()
            ->when($request->get('role'), function($query, $role){
                return $query->ByRole($role);
            })
            ->orderBy('id', 'desc')
            ->paginate(request('limit', 10));

        return UserResource::collection($users);
    }

[Дмитрий]

lexstile, если уже вы используете scope вы when можете перенести ровно в тот самый скоуп

[Дмитрий]

JhaoDa, что-то не так?

[lexstile]

Дмитрий, то есть, примерно так?

public function getEmployees(Request $request, Project $project)
    {
        $users = $project->users()
            ->ByRole($request->get('role'))
            ->orderBy('id', 'desc')
            ->paginate(request('limit', 10));

        return UserResource::collection($users);
    }

    public function scopeByRole($query, $role)
    {
        if(!is_array($role)){
            $role = [$role];
        }
        
        return $query->when($role, function($query, $role){
            return $query->whereIn('role', $role);
        });
    }

[Дмитрий]

lexstile, как то так да. Хотя конструкция когда вы все херачите в массив а потом проверяете when - на мой взгляд выглядит странно. Но думать не хочется