kalimeromk/filterable

Address commonly face the problem of adding repetitive filtering code

v1.6 2023-11-27 19:09 UTC

Requires

• php: >=8.0

Requires (Dev)

• orchestra/testbench: ^6.0

MIT

• Zoran Shefot Bogoevski

• laravel

README

In Laravel, we commonly face the problem of adding repetitive filtering code, sorting and search as well this package will address this problem.

Install

composer require kalimeromk/filterable

Usage for Filtering property

To use Filterable trait we need to include trait into our model

Use Filterable;

While adding Filterable trait in the model class, we need to add some properties as well.

$getFillable: Specify all the fields which exist in your table.

$boolFields:- Add fields on which you want to apply Boolean filtering.

Examples

        protected array $getFillable = [
            'name',
            'email',
            'address',
        ];

        protected array $boolFields = [
            'is_active',
        ];

After all the above changes, now we only need to call filter() function with Request array data

<?php
namespace App\Http\Controllers;

use App\Http\Controllers\Controller;
use App\User;
use Illuminate\Http\Request;

class UsersController extends Controller
{
	protected $model;
  
	public function __construct(User $model)
	{
		$this->model = $model;
	}
  
	public function index(Request $request)
	{
		$users = $this->model
                  ->filter($request->all())
                  ->get();
		
		return view('users.index', compact('users'));
	}
}

Usage for Sort property

To use Sortable trait we need to include trait into our model

Use Sortable;

While adding Sortable trait in the model class, we need to add some properties as well.

$sortable:- Add fields on which you want to apply sort property.

Examples

        protected array $sortable = [
            'id',
            'name',
            'email',
            'address'
        ];

After all the above changes, now we only need to call sort() function with Request array data

Example below allows sorting for the columns: id, name, email, address

<?php

namespace App;

use Kalimeromk\Filterable\Trait\Sortable;
use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    use Sortable;

    public $sortables = ['id', 'name', 'email', 'address'];
}

Trait usage

Below is an example of the usage of the sortable trait (query scope).

<?php
namespace App\Http\Controllers;

use App\Http\Controllers\Controller;
use App\User;
use Illuminate\Http\Request;

class UsersController extends Controller
{
	protected $model;
  
	public function __construct(User $model)
	{
		$this->model = $model;
	}
  
	public function index(Request $request)
	{
		$users = $this->model
                  ->sort($request->all())
                  ->get();
		
		return view('users.index', compact('users'));
	}
}

Usage for whereLike property

To use whereLike search need first to specified all the table row you want to search try

$likeRows:- Add fields on which you want to apply whereLike property.

Examples

    public const likeRows = [
        'name',
        'email',
        'address'
   ];

After all the above changes, now we only need to call whereLike() function with Request array data

Example below allows searching for the columns: name, email, address

<?php

namespace App;

use Kalimeromk\Filterable\Trait\Sortable;
use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    public const likeRows = [
        'name',
        'email',
        'address'
        ];
}

this method can be used to search try relation as well just update const with relation and row name for search

 public const likeRows = [
        'name',
        'email',
        'address',
        'country.name'
        ];

whereLike usage

Below is an example of the usage of the whereLike method (query scope).

<?php
namespace App\Http\Controllers;

use App\Http\Controllers\Controller;
use App\User;
use Illuminate\Http\Request;

class UsersController extends Controller
{
	protected $model;
  
	public function __construct(User $model)
	{
		$this->model = $model;
	}
  
	public function index(Request $request)
	{
		$users = $this->model
                  ->whereLike(User::likeRows, Arr::get($request, 'search'))
                  ->get();
		
		return view('users.index', compact('users'));
	}
}

NOTE: This also works with filter, sort and with pagination

$users = $this->model->whereLike(User::likeRows, Arr::get($request, 'search'))->sort($request->all())->filter($request->all())->paginate(10)

Testing

Run the tests with:

vendor/bin/phpunit

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Credits

• kalimeromk
• All Contributors

Security

If you discover any security-related issues, please email [e-mail] or use the issue tracker.

License

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