Download the PHP package henzeb/query-filter-builder without Composer
On this page you can find all versions of the php package henzeb/query-filter-builder. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package query-filter-builder
Query Filter Builder
Whenever you need filters on your API's endpoints, this package gives you a nice and simple interface that allows you to add filters without the need of a thousand parameters passed to your methods or writing SQL queries inside your controllers.
This comes with support for Laravel. If you'd like to contribute for other frameworks, see Contributing.
Installation
You can install the package via composer:
Usage
See here for Laravel specific usage.
In your controller you may build up something like this, based on parameters given by the user of your application.
Building the query using Laravel's query builder, can be done as such:
This would result in the following query:
Note: a query filter can never start with or
. This prevents data-leak
situations where one could get for example all records of it's own or the
dogs from another veterinarian:
Where one could get all records of it's own or the dogs from another veterinarian.
Custom filters
You can also create your own filters in case you need something specific.
When building with Laravel, your custom filter could look like this:
You can then call it like this:
Which would result in a query like this:
Creating your own builder.
Simply implement the Henzeb\Query\Builders\Contracts\QueryBuilder
interface.
Custom filters
The custom filters approach might feel a bit strange. You must create your
own custom filter interface, as the default
Henzeb\Query\Illuminate\Filters\Contracts\Filter
interface does not have any
methods.
See Henzeb\Query\Illuminate\Builders\Builder
for an example on proxying in
order to enable your IDE's typehinting.
If you have a better approach, please let me know or submit a pull-request.
Testing
Changelog
Please see CHANGELOG for more information what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
License
The GNU AGPLv. Please see License File for more information.