anhtt/laravel-filter-builder

Easily build Eloquent queries from API requests

dev-main 2024-07-29 08:20 UTC

Requires

• php: ^7.4 || ^8.0

MIT

• AnhTT

• anhtt
• laravel-filter-builder

README

Basic usage

Installation

composer require anhtt/laravel-filter-builder:dev-main

//app/Models/User.php
use AnhTT\FilterBuilder\Filterable;

class User extends Authenticatable
{
   use  Filterable;

FilterConfig a query based on a request: /users?name=John:

use AnhTT\FilterBuilder\FilterConfig;

    $filterConfig = new FilterConfig();
    $filterConfig->setFilters([
            'id' => 'users.id:cn',
            'name' => [
                'users.id:eq',
                'users.name:cn',
            ],
            'email' => 'users.email:eq',
            'email_and_name' => function (Builder $builder, $value) {
                $builder->where('users.name', '=', $value);
                $builder->where('users.email', '=', $value);
            },
            'color_name' => 'colors.name:eq',
            'product_name' => 'products.name:cn',
        ])->setSorts([
            'id' => 'users.id',
            'name' => 'users.name',
        ])->setJoins([
            'products' => ['products', 'products.user_id', '=', 'users.id', 'left'],
            'colors' => ['colors', function (JoinClause $join) {
                $join->on('colors.id', '=', 'products.color_id');
            }],
        ])->setJoinPriority([
            'colors' => ['products']
        ])->setDefaultSort('id:desc');

'eq' => $query->where($column, $value)
'ne' => $query->whereNot($column, $value)
'in' => $query->whereIn($column, $value)
'ni' => $query->whereNotIn($column, $value)
'cn' => $query->where($column, 'like', "%$value%")
'sw' => $query->where($column, 'like', "$value%")

Filter Form:

<?php

namespace App\Filters;

use Illuminate\Database\Query\JoinClause;
use AnhTT\FilterBuilder\FilterForm;

class UserFilterForm extends FilterForm
{

    public function filters(): array
    {
        return [
            'id' => 'users.id:eq',
            'name' => [
                'users.id:eq',
                'users.name:cn',
            ],
            'email' => 'users.email:eq',
            'category_name' => 'categories.name:eq',
            'color_name' => 'colors.name:eq',
            'product_name' => 'products.name:cn',
        ];
    }

    /**
     * @return array
     */
    public function getJoins(): array
    {
        return [
            'products' => ['products', 'products.user_id', '=', 'users.id', 'left'],
            'colors' => ['colors', function (JoinClause $join) {
                $join->on('colors.id', '=', 'products.color_id');
            }],
        ];
    }

    public function getSorts(): array
    {
        return [
            'id' => 'users.id',
        ];
    }

    public function getJoinPriority(): array
    {
        return [
            'colors' => ['products']
        ];
    }

    public function defaultSort(): string
    {
        return 'id:desc';
    }
}

use AnhTT\FilterBuilder\FilterConfig;

   $filterConfig = new UserFilterForm();
   $users = User::filterBuilder($requestData, $filterConfig, request('sort'))->paginate();

License

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