Building a Reusable Laravel Model Filter for Dynamic Querying

Laravel is known for its elegance and ease of use, and one of the areas where it truly shines is in database querying. Often, you’ll find yourself needing to build complex queries based on user input or other dynamic factors. Laravel’s Eloquent ORM offers a clean and simple way to interact with your database, but what if you want to make your model queries more flexible? Enter the concept of model filtering.

In this blog, we’ll explore how to create a reusable and powerful model filter in Laravel. This will allow you to dynamically apply query conditions based on incoming request parameters, making your Eloquent queries more modular and maintainable.

Why Use a Model Filter?

A model filter in Laravel is a class that encapsulates all the logic required to build dynamic query conditions based on user input. This helps in keeping your controllers clean, reusing code, and making your application more modular.

Advantages of using a model filter:

• Separation of Concerns: Keeps your controller clean by moving query logic into a dedicated class.

• Reusability: Allows you to reuse the same filter logic across multiple controllers or queries.

• Flexibility: Makes it easier to add or modify query conditions without altering the core logic of your application.

Step-by-Step Guide to Implementing a Model Filter

Step 1: Setting Up the Filter Class

Start by creating a base filter class that will handle the dynamic addition of query conditions. This class will take care of applying filters based on the request data.

<?php

namespace App\Filters;

use Illuminate\Database\Eloquent\Builder;

abstract class QueryFilter
{
    protected $request;
    protected $builder;

    public function __construct($request)
    {
        $this->request = $request;
    }

    public function apply(Builder $builder)
    {
        $this->builder = $builder;

        foreach ($this->filters() as $filter => $value) {
            if (method_exists($this, $filter)) {
                $this->$filter($value);
            }
        }

        return $this->builder;
    }

    public function filters()
    {
        return $this->request->all();
    }
}

Step 2: Creating Specific Filter Classes

Next, create a specific filter class for the model you want to filter. This class will extend the base QueryFilter class and contain methods for each filterable attribute.

For example, let’s say you have a Product model and you want to filter by category, price, and availability.

<?php

namespace App\Filters;

class ProductFilter extends QueryFilter
{
    public function category($value)
    {
        return $this->builder->where('category_id', $value);
    }

    public function price($value)
    {
        return $this->builder->where('price', '<=', $value);
    }

    public function availability($value)
    {
        return $this->builder->where('availability', $value);
    }
}

Step 3: Applying the Filter in Your Controller

Now, apply the filter in your controller to dynamically filter the results based on the request parameters.

<?php

namespace App\Http\Controllers;

use App\Models\Product;
use App\Filters\ProductFilter;
use Illuminate\Http\Request;

class ProductController extends Controller
{
    public function index(Request $request, ProductFilter $filters)
    {
        $products = Product::filter($filters)->get();

        return view('products.index', compact('products'));
    }
}

Step 4: Adding a Filter Scope to the Model

To make it easy to apply filters, add a scope to your Eloquent model.

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class Product extends Model
{
    public function scopeFilter($query, $filters)
    {
        return $filters->apply($query);
    }
}

Step 5: Using the Filter in Your Application

With everything set up, you can now easily filter your Product model based on the incoming request parameters. For example:

// Example: /products?category=1&price=100&availability=in_stock

This URL will filter the products based on the specified category, price, and availability, and the filtered results will be displayed to the user.

Conclusion

Model filtering in Laravel is a powerful way to handle dynamic query conditions with clean, reusable code. By following the steps above, you can create a flexible filter system that simplifies your controllers and makes your application more maintainable. This approach not only helps in writing less code but also makes your queries more adaptable to future requirements.

In your journey as a Laravel developer, mastering such patterns will significantly enhance the quality and scalability of your applications. So, give it a try and take your Laravel queries to the next level!

Enjoy!