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

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 - на мой взгляд выглядит странно. Но думать не хочется

Answer 1

[Григорий Васильков]

Не вижу ничего плохого в том, чтобы использовать if () вместо ->when()

Будьте осторожны с "приходит - фильтруем, не приходит - отдаем все", учитывайте что может прийти только ключ, а еще может прийти пустое значение - пустой массив или пустая строка или цифра 0. А ещё "все" бывает 100 тысяч. А еше база бывает 15 миллионов, и выбрать 12000-ую страницу из 15 миллионов не так то просто, особенно когда у вас есть сортировка. Сортировку внедрять везде - это трудно.

Лучше всего отталкиваться от array_key_exists(). В вашем случае "если роль находится в допустимом списке то фильтровать" несколько ограничивает вас на пример "роль это константа". В проекте константой является не роль, а разрешение, а роль это для удобства пользователя - группа разрешений. Ролей человек наделает тьму, а вот разрешений сколько кодер накодит столько и будет. Но, да, есть фиксированные роли (они же - базовые) GUEST/USER/BANNED/ROOT. Это не меняет тот факт, что поведение "если присланное клиентом не находится в нашем списке, то программа не работает" - в вашем случае она должна сработать но вернуть пустой список.

Просто проверяешь запрос на наличие поля (для этого убираешь в ларавеле там мидлвар ConvertEmptyStringsToNull, т.к. это семантически неверное поведение для апи, хотя и рекомендуемое в ларе).

when и колбэки - это процессорные вызовы, контексты, и лишний расход памяти, ифы это легче. Если б они давали что-то кроме вертикалости написания, но ведь нет. Не то чтобы я призываю писать вас вложенных тысячу ифов, ифы тоже надо уметь упрощать до 1-2 уровня или массива-маппинга.

Comments

[lexstile]

Благодарю за советы, весьма полезно.