Looking to hire Laravel developers? Try LaraJobs

laravel-filterable maintained by fomvasss

Description
Package for build filters in eloquent models
Author
Last update
2022/04/20 10:17 (dev-master)
License
Links
Downloads
865

Comments
comments powered by Disqus

Laravel Filterable

License Build Status Latest Stable Version Total Downloads Quality Score

Package for easy filtering and searching in your Eloquent models


Installation

Run from the command line:

composer require fomvasss/laravel-filterable

Publishing

php artisan vendor:publish --provider="Fomvasss\Filterable\ServiceProvider"

Integration

Usage in Eloquent models trait

Fomvasss\Filterable\Filterable

Usage

app/Models/Article.php

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Fomvasss\Filterable\Filterable;

class Article extends Model
{
    use Filterable;
    
    protected $filterable = [
        'title' => 'like',              // http://site.test/post?filter[title]=Some+title
        'price' => 'between',           // http://site.test/post?filter[price_from]=120&filter[price_to]=380
        'category_id' => 'equal',       // http://site.test/post?filter[category_id]=2
        'status' => 'in',               // http://site.test/post?filter[status][]=publish&filter[status][]=active or http://site.test/post?filter[status]=publish|active
        'created_at' => 'between_date', //http://site.test/post?filter[created_at_from]=14.10.2018&filter[created_at_to]=24.11.2018
        'updated_at' => 'equal_date',   //http://site.test/post?filter[updated_at]=14.10.2018
        'price_exists' => 'custom',     //http://site.test/post?filter[price_exists]=1 - check exists price

        // Relation model field (for `equal` and `in`)
        'user.name' => 'like',          // http://site.test/post?filter[user.name]=Ева%20Максимовна%20Терентьева
    ];
    
    protected $searchable = [
        'name', 'email', 'contacts.city'
    ];
}

app/Http/Controllers/Article.php

<?php 

namespace App\Http\Controllers;

use Fomvasss\MediaLibraryExtension\MediaLibraryManager;

class HomeController extends Controller 
{
    public function index(Request $request)
    {
        $articles = \App\Model\Article::filterable($request->filter)
            ->searchable($request->q)
            ->get();

        return $articles;
    }
}

Links