kblais/query-filter

Easily create filters for your Eloquent model.

Maintainers

Details

github.com/kblais/query-filter

Source

Issues

Installs: 14 181

Dependents: 1

Suggesters: 0

Security: 0

Stars: 18

Watchers: 1

Forks: 4

Open Issues: 1

1.7.0 2020-12-08 12:21 UTC

Requires

Requires (Dev)

MIT f9a4fd6a66029ed8927db0752802be6ae817dfba

  • Killian Blais <contact.woop@killianblais.fr>

This package is auto-updated.

Last update: 2021-02-25 20:18:12 UTC

README

Easily create filters for your Eloquent model.

Based on Jeffray Way's Laracast tutorial.

Installation

You can install this package via Composer with this command:

composer require kblais/query-filter

Usage

  • Create your model filters, for exemple in a App\Http\Filters namespace :
<?php

namespace App\Http\Filters;

use Kblais\QueryFilter\QueryFilter;

class MyModelFilter extends QueryFilter
{
    public function foo($value)
    {
        return $this->builder->where('foo', 'bar');
    }
}
  • Then, add the FilterableTrait on your model to allow the use of MyModel::filter() :
<?php

namespace App;

use Illuminate\Database\Eloquent\Model;
use Kblais\QueryFilter\FilterableTrait;

class MyClass extends Model
{
    use FilterableTrait;
}
  • Finally, you can use the MyModel::filter() method in your controller :
<?php

namespace App\Http\Controllers;

use App\Http\Filters\MyModelFilter;
use App\MyModel;
use Kblais\QueryFilter\FilterableTrait;

class MyController extends Controller
{
    public function index(MyModelFilter $filters)
    {
        $data = MyModel::filter($filters)->get();

        return response()->json(compact('data'));
    }
}

Contributing

  • Follow the PSR-2 Coding Standard. Use PHP-CS-Fixer to apply the conventions.
  • Add tests !
  • Create feature branches
  • One pull request per feature