Download the PHP package timedoor/laravel-filter without Composer
On this page you can find all versions of the php package timedoor/laravel-filter. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download timedoor/laravel-filter
More information about timedoor/laravel-filter
Files in timedoor/laravel-filter
Package laravel-filter
Short Description Package for filtering data from request
License MIT
Homepage https://github.com/backend-timedoor/laravel-filter
Informations about the package laravel-filter
Laravel Filter
This package is used to filter data from request in a simple way.
Installation
You can install the package via composer:
Usage
Create a filter class
In default, all filter class are stored inside app/Http/Filters folder. If you want to store it in another folder, you can pass the full namespace instead of the name
After you successfully create the filter class, it will look like this:
Use Filterable trait
Add the Filterable trait inside your model.
Filtering Data
After you finished the required setup, now you can filter data in your controller:
Cases
Let's say your application inside http://your-domain.com
and you want to filter user data by their name, so the request will be like http://your-domain.com?name=John
you can handle it like this:
Advance Usage
Using Custom Laravel Query Builder
In case you want to use your own laravel query builder, you need to follow this setup:
Make sure your query builder is extended to LaravelFilterQueryBuilder class
Now you can implement filter with your own query builder.
Using with Options
There are 2 options that available include
and exclude
you can pass the options inside applyFilter() method
Include
This option is when you want to call filter method even if the request params is not set. For example you want to filter user by their names and your endpoint looks like this http://localhost/user?name=John
. But if the request doesn't have name
query your filter method will not called. If you want to always call your filter method even if the request doesn't have query, you can use include
option
Exclude
This option is for prevent the filter method called. For example you have name()
method inside your filter class and the request query looks like this http://localhost/user?name=John
. But you don't want name()
method called, you can use exclude option
Chaining Filter
If you want to use more than 1 filter class, you can chain the applyFilter
method, so it will looks like this:
Testing
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Credits
License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-filter with dependencies
illuminate/contracts Version ^8.0|^9.0|^10.0|^11.0
illuminate/support Version ^8.0|^9.0|^10.0|^11.0
spatie/laravel-package-tools Version ^1.14.0