Download the PHP package laravellegends/eloquent-filter without Composer
On this page you can find all versions of the php package laravellegends/eloquent-filter. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download laravellegends/eloquent-filter
More information about laravellegends/eloquent-filter
Files in laravellegends/eloquent-filter
Package eloquent-filter
Short Description A simple Eloquent filter to make easy API filtering
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package eloquent-filter
Laravel Legends Eloquent Filter
A useful library to make filters for Eloquent.
This library is useful to create search filters in your Rest API using the Eloquent.
🇧🇷🚀🚀🚀
Description
The Eloquent Filter library can be used to create patterns for search criterias on models in your Laravel Project. The idea is aggregate filters simply passing the values in your request payload.
Instalation
For instalation, you should be use Composer. Run the follow command:
Usage guide
The LaravelLegends\EloquentFilter\Concerns\HasFilter trait can be used in models that will be apply the search filters.
The HasFilter trait provides the filter and withFilter methods.
A simple way to use this library in your Laravel application is calling the filter method before get results of your model.
Example:
You can show the results when call /api/users?exact[id]=1. The sql query "select * from users where (id = 1)" will be applied.
Note: Show the rules session to more information.
Another way, is using the specific filter for a model. You can inherit the ModelFilter class to create a custom filter for a model.
For create this class, you should be use the command php artisan make:filter, as follow example:
The above command will be generate the follow class:
In Controller
The above code internally will be called as follow example:
What does it do?
This library internally apply filters based on query string parameters with special keyworks names.
See all paramaters follow:
max
The maximum value of a column. The url api/users?max[field]=100 is like a User::where('field', '<=', 100).
min
The minimum value of a column. The url api/users?min[age]=33 is like a User::where('age', '>=', 33).
contains
A search term contained in a column.
The url api/users?contains[name]=wallace is like a User::where('name', 'LIKE', '%wallace%').
ends_with
Search a value according to end content of string. Is similar to a LIKE with %$value value.
starts_with
Filter the field when the value starts with a certain value.
A url api/users?starts_with[name]=brcontainer Sounds like a User::where('name', 'LIKE', 'brcontainer%').
exact
Search by a exact value of the field·
A url api/users?exact[email][email protected] Sounds like a User::where('name', '=', '[email protected]').
has
Filter by relationship. You can use the 0 or 1 value.
Example:
The url api/users?has[posts]=1 is like a User::has('posts')
The url api/users?has[posts]=0 is like a User::doesntHave('posts')
is_null
Apply WHERE IS NULL or WHERE IS NOT NULL to a query.
Example:
The url api/users?is_null[cpf]=1 is like a User::whereNull('cpf')
The url api/users?is_null[age]=0 is like a User::whereNotNull('age')
not_in
Searchs when a column NOT HAS the passed values.
Example:
A url api/users?not_in[role][]=1¬_in[role][]=2 é equivalente à User::whereNotIn('role', [1, 2])
Note: When the not_in[my_field] is a empty array, no action will be taken.
in
Searchs when a column HAS the passed values.
Example:
The url api/users?in[role][]=10&in[role][]=20 sounds like a User::whereIn('role', [10, 20])
NOTE: When the in[my_field] is a empty array, no action will be taken.
date_max
Search by a maximium value of a date field.
A url api/users?date_max[created_at]=2021-01-01 sounds like a User::whereDate('created_at', '<=', '2021-01-01')
date_min
Search by a minimun value of a date field.
Example:
A url api/users?date_min[created_at]=2021-01-01 sounds like a User::whereDate('created_at', '>=', '2021-01-01')
not_equal
Search by not equal value passed. If you use in related field, the whereDoesntHave will be applied applied.
Example:
The url api/users?not_equal[profile_id]=3 sounds like a
The url api/users?not_equal[roles.id]=1 sounds like a
year_max
The url api/users?year_max[created_at]=2000 sounds like a
year_min
The url api/users?year_min[created_at]=1998 sounds like a
year_exact
The url api/users?year_exact[created_at]=1998 sounds like a
Filtering relationship fields
You can apply the search filters in the relatioship methods defined in your model.
For example:
Model:
Filters:
In the following example, the user will be filtered for the related phone containing the value 55.
The is like to:
Axios examples
If you use axios library, you can use the params options to include the above filters.
Example:
