laravel-filter/filter

the package is for filtering data for EXP you have search bar/page with multi filters option this package will help you to do that filters easily and fast this package using pipeline technology and it will check the request part by part

dev-master 2022-02-12 16:23 UTC

Requires

• php: >=7.4
• laravel/framework: >=6.0

MIT

• alireza alizade

• package
• search
• filter
• laravel
• usee

README

The blackWhaleDev/filter package provides easy to writing global queries for filtering.

Here's a demo of how you can use it:

pipe(New User(),
    [
        NameFilter::class,
    ])->paginate(10);

You can create your own filter class using artisan command :

php artisan make:filter ClassName ColumnName 

This Command have some option:

--type --second --relation=

Support us

You can support me by using this package and help me to improve it

Documentation

For EXP: you have search page and you want set some filters for that page, and this filters should be apply on User class.

first with artisan call we create 2 class (Name and LastNameLike):

name:

php artisan make:filter Name FirstName

this command will generate "Name.php" file in "App\QueryFilters" Folder

Note: the column that we want make filter on it is "first_name" but we should write it in CamelCase and also in the HTML form input name should be the same of column name "first_name"

now second class :

php artisan make:filter LastName LastName --type=like

this command will generate "likeLastName.php" file in "App\QueryFilters" Folder

now call pipe() helper into your function

pipe(New User(), [
    Name::class,
    likeLastName::class, // --type = like
])->paginate(10);

just it ;) !!!

when request come into the helper its go to the Name Class and check if request has "name" it will be check and if request do not has "name" it will be go to next request (next class) without check

Find yourself stuck using the package? Found a bug? Do you have general questions or suggestions for improving the filter system? Feel free to create an issue on GitHub, I'll try to address it as soon as possible.

If you've found a security issue please mail [e-mail] instead of using the issue tracker.

Type of Artisan Call

Single:

php artisan make:filter Name FirstName

its default type

like:

php artisan make:filter Name FirstName --type=like

its "Like" Query

between:

php artisan make:filter Name StartDate --type=between --second=EndDate

in this type you should pass "--second" option and it will check data between two time or anything else...

--relation:

php artisan make:filter Name StartDate --type=relation --relation=RelationName

in this type you should pass "--relation" option and it will check data whereHas that relation

Installation

You can install the package via composer:

composer require laravel-filter/filter

The package will automatically register itself.

Note: Please Keep CamelCase Style

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

License

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