Download the PHP package culturegr/filterer without Composer
On this page you can find all versions of the php package culturegr/filterer. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
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 filterer
🏺 Filterer
This package provides an easy way to add filtering, sorting and paging functionality to Eloquent models.
Installation
Via Composer:
Usage
Assume the follwing database scheme:
The Client model that corresponds to the clients table is shown below:
IMPORTANT Filterer package strongly relies on Laravel conventions for naming the relationships between models. Therefore, in order for the package to work as expected, the defined model relationships should be named according to these convantions
Using the Trait
Filtering, sorting and paging functionality can be added to the Client model by using the Filterable trait provided by Filterer package:
Defining filterable and sortable fields
Fields that can be filtered and/or sorted must be explicitly defined using, respectively, the fiterable and sortable properties on the model. Both filterable and sortable fields may exist on the model itself or on its first-level relationships:
- Fields that exist on the model itself are defined using the name of the column, i.e
columnName - Fields that exist on a related model are defined using the relationship name followed by a dot
.and the name of the column on the related model, i.erelationshipName.columnName
For example, in order to be able to both filter and sort the Client model by age, country's name, orders' items and favorite products' price, the following filterable and sortable fields must be defined:
Supported data types and operators for filtering
The supported data types and their corresponding operations that can be performed when filtering resources are listed in the following table:
| Data types | Operators |
|---|---|
| Numeric (such as int, tinyint, bigint, float, real etc.) | equal_to, not_equal_to, less_than, greater_than, between, not_between |
| Date (such as date, datetime) | between_date |
| String (such as varchar, text etc) | equal, not_equal, contains |
Filtering models
Filtered results can be obtained using the filter method (provided by Filterable trait) and passing an array as an argument that has a filters property which contains a list of desired filters, as shown below:
IMPORTANT: The
filtermethod always returns an instance ofIlluminate\Database\Eloquent\Builder.
For example, the following filters can be applied in order to filter the clients that
- have age between 35 and 40
- are from Greece
- had made orders between the 1st and the 31st of May 2020
- have favorite products that cost less than 10 euros
Custom filters
Filterer now supports custom filters, allowing you to define complex or specific filtering logic for your models.
Creating a Custom Filter
Use the artisan command to generate a new custom filter:
This will create a new ActiveClientsFilter class in app/CustomFilters directory that implements the CustomFilter interface.
Then you can define your custom filter logic in the apply method.
For example, the following ActiveClientsFilter will filters clients who have made an order in the last 30 days.:
Registering Custom Filters
In your model, add your custom filter to the $customFilters array property:
Using Custom Filters
Now you can use your custom filter in your queries, like you would use any other filter:
Sorting models
Sorted results can be obtained using the filter method and passing an array as an argument that has a sorts property which contains a list of desired sorts, as shown below:
For example, the following sorts can be applied in order to sort the clients by
- age, ascending
- country name, descending
- number of items in their orders, ascending
- the price of their favorite products, descending
Paging models
Paginated results can be obtained using the filterPaginate method, as shown below:
IMPORTANT: The
filterPaginatemethod always returns an instance ofIlluminate\Pagination\LengthAwarePaginator. It uses thelimitfrom the query string if provided, otherwise it uses the$defaultLimitif set, and falls back to a default of 10 if neither is specified.By default, the current page is detected by the value of the page query string argument on the HTTP request. This value is automatically detected by Laravel, and is also automatically inserted into links generated by the paginator. For more information on how Laravel handles pagination see here
Combining filtering, sorting and paging
Filtering, sorting and paging functionality can be combined using the filterPaginate method provided by Filterable trait and passing as an argument an array that contains any three of the filters, sorts and limit/page properties:
Query string format
The argument of the filter method can be easily obtained by parsing a query string with the following format:
Testing
License
Please see the license file for more information.
Credits
- Code Kerala
- Awesome Laravel/PHP community
