Apply Dynamic Filters to Eloquent Models with the Filterable Package

Last updated on by

Apply Dynamic Filters to Eloquent Models with the Filterable Package image

Filterable is a Laravel package by Jerome Thayananthajothy that enhances Laravel queries with adaptable, customizable filters and intelligent caching to improve both performance and functionality.

The main features of this package include:

  • Dynamic Filtering: Apply filters based on request parameters with ease.
  • Caching: Improve performance by caching query results.
  • User-specific Filtering: Easily implement filters that depend on the authenticated user.
  • Custom Filter Methods: Extend the class to add your own filter methods.

Defining Filter classes is at the center of this package, where you can create methods that can apply filtering to Eloquent queries. The package includes a make:filter Artisan command to generate a filter in your app's App\Filters namespace. Here's an example of a filter from the package's README:

namespace App\Filters;
 
use Filterable\Filter;
use Illuminate\Database\Eloquent\Builder;
 
class PostFilter extends Filter
{
protected array $filters = ['status', 'category'];
 
protected function status(string $value): Builder
{
return $this->builder->where('status', $value);
}
 
protected function category(int $value): Builder
{
return $this->builder->where('category_id', $value);
}
}

Given a PostFilter, you can utilize this class in a controller with the Post model to filter models based on the HTTP query params:

public function index(Request $request, PostFilter $filter)
{
// i.e., /posts?status=active&category_id=2
$query = Post::filter($filter);
 
$posts = $request->has('paginate')
? $query->paginate($request->query('per_page', 20))
: $query->get();
 
return response()->json($posts);
}

You can learn more about this package, get full installation instructions, and view the source code on GitHub.

Paul Redmond photo

Staff writer at Laravel News. Full stack web developer and author.

Cube

Laravel Newsletter

Join 40k+ other developers and never miss out on new tips, tutorials, and more.

Laravel Forge logo

Laravel Forge

Easily create and manage your servers and deploy your Laravel applications in seconds.

Laravel Forge
Tinkerwell logo

Tinkerwell

The must-have code runner for Laravel developers. Tinker with AI, autocompletion and instant feedback on local and production environments.

Tinkerwell
Cut PHP Code Review Time & Bugs into Half with CodeRabbit logo

Cut PHP Code Review Time & Bugs into Half with CodeRabbit

CodeRabbit is an AI-powered code review tool that specializes in PHP and Laravel, running PHPStan and offering automated PR analysis, security checks, and custom review features while remaining free for open-source projects.

Cut PHP Code Review Time & Bugs into Half with CodeRabbit
Join the Mastering Laravel community logo

Join the Mastering Laravel community

Connect with experienced developers in a friendly, noise-free environment. Get insights, share ideas, and find support for your coding challenges. Join us today and elevate your Laravel skills!

Join the Mastering Laravel community
Laravel Idea for PhpStorm logo

Laravel Idea for PhpStorm

Ultimate PhpStorm plugin for Laravel developers, delivering lightning-fast code completion, intelligent navigation, and powerful generation tools to supercharge productivity.

Laravel Idea for PhpStorm
Kirschbaum logo

Kirschbaum

Providing innovation and stability to ensure your web application succeeds.

Kirschbaum
Shift logo

Shift

Running an old Laravel version? Instant, automated Laravel upgrades and code modernization to keep your applications fresh.

Shift
Bacancy logo

Bacancy

Supercharge your project with a seasoned Laravel developer with 4-6 years of experience for just $2500/month. Get 160 hours of dedicated expertise & a risk-free 15-day trial. Schedule a call now!

Bacancy
Lucky Media logo

Lucky Media

Get Lucky Now - the ideal choice for Laravel Development, with over a decade of experience!

Lucky Media
Lunar: Laravel E-Commerce logo

Lunar: Laravel E-Commerce

E-Commerce for Laravel. An open-source package that brings the power of modern headless e-commerce functionality to Laravel.

Lunar: Laravel E-Commerce
LaraJobs logo

LaraJobs

The official Laravel job board

LaraJobs
SaaSykit: Laravel SaaS Starter Kit logo

SaaSykit: Laravel SaaS Starter Kit

SaaSykit is a Multi-tenant Laravel SaaS Starter Kit that comes with all features required to run a modern SaaS. Payments, Beautiful Checkout, Admin Panel, User dashboard, Auth, Ready Components, Stats, Blog, Docs and more.

SaaSykit: Laravel SaaS Starter Kit
MongoDB logo

MongoDB

Enhance your PHP applications with the powerful integration of MongoDB and Laravel, empowering developers to build applications with ease and efficiency. Support transactional, search, analytics and mobile use cases while using the familiar Eloquent APIs. Discover how MongoDB's flexible, modern database can transform your Laravel applications.

MongoDB

The latest

View all →
Enum-Powered Route Permissions in Laravel image

Enum-Powered Route Permissions in Laravel

Read article
NativePHP for iOS image

NativePHP for iOS

Read article
Using Relative Date Helpers in Laravel's Query Builder image

Using Relative Date Helpers in Laravel's Query Builder

Read article
Fine-tuning Pagination Links in Laravel image

Fine-tuning Pagination Links in Laravel

Read article
Relative Date Helpers in Laravel 11.42 image

Relative Date Helpers in Laravel 11.42

Read article
Smart Route Detection in Laravel image

Smart Route Detection in Laravel

Read article