catalyzecomm/laravel-filterable

A Simple filter library for laravel

v1.0.1 2020-09-22 23:45 UTC

Requires

• php: ^7.2
• illuminate/database: ^6.18.31|^7.22.4
• illuminate/http: ^6.18.31|^7.22.4
• illuminate/pipeline: ^5.5|^6.0|^7.0
• illuminate/support: ^6.0|^7.0

MIT

• Fajar Budhi Iswanda

• filter
• laravel
• laravel-filterable
• catalyzecomm

README

This package allows you to easily handle database filtering through query strings.

Installation

You can install the package via composer:

for Laravel 6.x & 7.x

composer require catalyzecomm/laravel-filterable

Introduction

Introduction here

Usage

Define your model (use Catalyzecomm\Filterable Trait and define $allowedFilters)

    use Catalyzecomm\Filterable;

    ...

    /**
     * Define an array of filter that allowed to use for this model
     * `key` as class name and `value` as field name(s)
     *
     * @var array
     */
    protected static $allowedFilters = [
        Catalyzecomm\Filters\Sort::class => 'created_at',
        Catalyzecomm\Filters\Keywords::class => 'name,email',
    ];

Use on your controller

    $users = User::filterPaginate();

or

    $users = User::filterAll();

Credits

• catalyzecomm

License

The MIT License (MIT). Please see License File for more information.