本文旨在介绍如何在 Laravel 中根据用户提供的可选日期参数，灵活地过滤数据。我们将使用 Eloquent 模型和 when() 方法构建动态查询，避免复杂的条件判断，简化代码逻辑，提高代码可读性和可维护性。通过本文的学习，你将掌握一种高效的日期过滤方法，并能将其应用于各种实际场景中。
使用 when() 方法构建动态日期查询
在 Laravel 中，处理可选参数的日期过滤时，一种简洁而高效的方法是使用 Eloquent 查询构建器的 when() 方法。when() 方法允许你根据条件动态地添加查询约束。这可以避免编写冗长的 if...else 语句，使代码更加清晰易懂。
以下是一个示例，展示了如何使用 when() 方法根据 start-date 和 end-date 参数过滤 AnalyticsOrder 模型的数据：
use App\Models\AnalyticsOrder;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Auth;
public function getAnalyticsData(Request $request)
{
$startDate = $request->input('start-date');
$endDate = $request->input('end-date');
$workgroupId = $request->input('workgroup-id');
$user = Auth::user(); // 假设已进行用户认证
$workgroups = AnalyticsOrder::where('workgroup_id', $workgroupId)
->whereHas('workgroup', function ($query) use ($user) {
$query->where('user_id', $user->id);
})
->when($startDate, function ($query) use ($startDate) {
$query->where('created_at', '>=', $startDate);
})
->when($endDate, function ($query) use ($endDate) {
$query->where('created_at', '<=', $endDate);
})
->get();
return response()->json($workgroups);
}代码解释：
- 获取请求参数： 首先，从请求中获取 start-date、end-date 和 workgroup-id 参数。
- 构建基础查询： 使用 AnalyticsOrder::where('workgroup_id', $workgroupId) 构建基础查询，筛选特定工作组的数据。
- 关联查询 (whereHas)： 使用 whereHas 确保查询结果关联到属于当前用户的工作组。
-
when() 方法：
- ->when($startDate, function ($query) use ($startDate) { ... })：如果 $startDate 存在（非空），则执行闭包内的查询。闭包接收一个 $query 对象，允许你添加额外的查询约束。这里，我们添加了一个 where('created_at', '>=', $startDate) 约束，筛选 created_at 大于或等于 $startDate 的数据。
- ->when($endDate, function ($query) use ($endDate) { ... })：类似地，如果 $endDate 存在，则添加 where('created_at', '<=', $endDate) 约束，筛选 created_at 小于或等于 $endDate 的数据。
- 执行查询： 最后，使用 ->get() 方法执行查询，并返回结果。
注意事项：
- 确保 $startDate 和 $endDate 变量包含有效的日期格式，以便与数据库中的 created_at 字段进行比较。
- Auth::user() 假设你已经设置了身份验证系统。
- whereHas 用于确保用户只能访问他们有权访问的数据。
总结
使用 when() 方法可以有效地简化 Laravel 中的日期条件过滤逻辑，提高代码的可读性和可维护性。通过构建动态查询，你可以轻松地处理可选参数，并根据需要添加或删除查询约束。这种方法不仅适用于日期过滤，还可以应用于其他类型的条件查询，使你的代码更加灵活和健壮。记住始终验证用户输入，并确保你的查询安全可靠。
