Installation
Require the package. The service provider is auto-discovered and there is nothing to migrate — the package ships no migrations or models. It only reads the request and mutates a query builder your application owns:
composer require roundly-consulting/query-builder-for-laravelThe config file is optional — the shipped defaults are the intended wire contract. Publish it only to change parameter names, page-size bounds, unknown-parameter behaviour or request limits:
php artisan vendor:publish --tag="query-builder-config"The two HTTP 400 error messages are translatable. Publish them to override the wording or add a locale:
php artisan vendor:publish --tag="query-builder-translations"Inspect the wire contract
The package contributes a section to php artisan about that prints the contract it is currently serving — parameter names, page-size bounds, unknown-parameter modes and limits:
php artisan about --only=query-builder| Line | Default output |
|---|---|
| Filter parameter | filter |
| Sort parameter | sort |
| Page parameters | page / per_page |
| Page size | 20 default, 100 max |
| Unknown filter | REJECT |
| Unknown sort | REJECT |
| Request limits | 50 value(s), 255 char(s), 5 sort(s) |
Nothing in this section is secret: the config is the public wire contract a client already sends.
Show your open-source love
This package is free and MIT-licensed. If it saves you time, a one-off donation or a Patreon membership keeps it maintained, tested and documented.
More ways to support, including cryptoBy donating, you agree to our donation terms.
Want this built into your product?
We integrate our packages into custom Laravel and AI builds. Tell us what you're working on and we'll reply within 48 hours.