Laravel when Method for Advanced Querying

 

What is the Laravel when Method?

The Laravel when method is a versatile feature that enables you to conditionally add clauses to your queries.

This conditional approach allows you to build complex queries with ease, depending on specific conditions being met.

Without when()

$q = Product::query();

if ($req->has('category')) {

$q->where('category_id',$req>input('category'));

}

if ($req->has('price')) {

$q->where('price', '<=', $req->input('price'));

}

$products = $q->get();

The Syntax of the when Method

The when method has a straightforward syntax:

Whether you need to filter results, apply sorting, or include additional constraints, the when method can streamline your code and make it more concise.

syntax:

$query->when($condition,function ($query) { 
// Define query clauses based on the condition 
});

Here, $condition represents the condition that, when evaluated as true, triggers the execution of the callback function. Within the callback, you can apply query constraints specific to the given condition.

Practical Examples

Example 1: Filtering Results

Suppose you have a list of products, and you want to filter them based on user input. Instead of writing separate queries for each filter option, you can use the when method:

$products = Product::query()
->when($request->has('category'), function ($q) use ($request) { 
 $q->where('category_id', $request->input('category'));
 })->when($request->has('price'), function ($q) use ($request) { 
 $q->where('price','<=',$request->input('price')); 
 })->get();

Example 2: Dynamic Sorting

You can dynamically sort query results based on user preferences:

$orderBy = $request->input('sort_by', 'created_at'); 
$orderDirection = $request->input('sort_direction', 'desc'); 
$posts = Post::query()
->when($orderBy, function ($q) use ($orderBy, $orderDirection) { 
 $q->orderBy($orderBy,$orderDirection); 
 })->get();

Conclusion

The Laravel when method is a versatile tool that can greatly enhance your query-building capabilities.

Its ability to keep your code clean, efficient, and readable .

Happy coding!