Requirements

• PHP 8.+
• Laravel 10.x or higher

Installation

Install the package via Composer:

composer require kettasoft/filterable

Setup

Step 1: Register the service provider

Note: Laravel 11+ registers providers automatically via package discovery. Skip this step if you're on Laravel 11+.

Add the service provider to the providers array in config/app.php:

'providers' => [
    // ...
    Kettasoft\Filterable\Providers\FilterableServiceProvider::class,
],

Step 2: Publish configuration and stubs

Publish the config file:

php artisan vendor:publish \
  --provider="Kettasoft\Filterable\Providers\FilterableServiceProvider" \
  --tag="config"

Publish the stubs:

php artisan vendor:publish \
  --provider="Kettasoft\Filterable\Providers\FilterableServiceProvider" \
  --tag="stubs"

Step 3: Add the Filterable trait to your model

Include the Filterable trait in any Eloquent model you want to filter:

<?php

use Kettasoft\Filterable\Filterable;

class Post extends Model
{
    use Filterable;
}

Step 4: Create a filter class

Generate a filter class for your model using the Artisan command:

php artisan kettasoft:make-filter PostFilter --filters=title,status

This generates a dedicated filter class where you define your filter methods.

---

Next, learn how to define filter methods and apply them to your queries.

Contributors: Abdalrhman Emad Saad, kettasoft

Previous pageIntroduction

Next pageService Provider