Download the PHP package kamil-koscielniak/eloquent-filters without Composer
On this page you can find all versions of the php package kamil-koscielniak/eloquent-filters. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download kamil-koscielniak/eloquent-filters
More information about kamil-koscielniak/eloquent-filters
Files in kamil-koscielniak/eloquent-filters
Package eloquent-filters
Short Description Simply way to add filters to Eloquent models
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-filters
Laravel Eloquent filters
Laravel package for simply adding filters to Eloquent models.
Instalation
Usage
Step 1 - Define filters in Eloquent model
Note that the names of filters (code and price in above example) must be same as the column names in database table.
Step 2 - Filtering data
For example you can filter your data like this
Step 3 - Use filters in query string
Example url below will return products with price between 21.99 and 99.99 `
Available filter types
PartialFilter
For partial searching.
Example usage:
Above example will retrieve products which names contains phrase blue
ExactFilter
For exact searching.
Example usage:
Above example will retrieve customers which names are equals to mike
RangeFilter
For range searching.
Use range separator / to separate min and max values
Example usage:
Above example will retrieve products which price are between 21.99 and 99.99
Note that provided values must be numeric.
By default RangeFilter use operators <= and >=.
If you don't want include provided values in search results than use exclusion mode.
Example usage with exclusion mode:
Above example will retrieve products which price is greater than 21.99 and lower or equal than 99.99
Searching in relationships
Sample eloquent model with relationship filter:
In example above filter category__code is relationship filter because it use FILTERS_RELATIONSHIP_SEPARATOR
in name (by default __). In this filter name category is name of relationship and code is column name in related Category model.
So this filter give you possibility to filter Product models by code of related Category model.
Exclusion mode
In each of filter types you can use exclusion mode. Just add |e suffix to value that you want to exclude.
If you want use custom suffix you can change it, see Configuration section below.
Configuration
Run php artisan vendor:publish --tag=config
Config file you will find in app/filters.php
Available options
| Option | Default value | Description |
|---|---|---|
| FILTERS_EXCLUSION_SUFFIX | |e | For exclusion value. Example usage ?name=bike|e |
| FILTERS_RANGE_SEPARATOR | / |
For range searching. Use in query string. Example usage ?price=21.99/99.99 |
| FILTERS_RELATIONSHIP_SEPARATOR | __ |
When you want to search in related object use relationship separator ?customer__name=mike |
License
The MIT License (MIT). Please see License File for more information.
All versions of eloquent-filters with dependencies
illuminate/http Version ^6.0|^7.0
illuminate/support Version ^6.0|^7.0
illuminate/database Version ^6.0|^7.0