Download the PHP package foxws/laravel-scout-builder without Composer
On this page you can find all versions of the php package foxws/laravel-scout-builder. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download foxws/laravel-scout-builder
More information about foxws/laravel-scout-builder
Files in foxws/laravel-scout-builder
Package laravel-scout-builder
Short Description Easily build Scout queries from API requests
License MIT
Homepage https://github.com/foxws/laravel-scout-builder
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 laravel-scout-builder
laravel-scout-builder
A Laravel Scout query builder inspired by and largely derived from spatie/laravel-query-builder. It brings the same AllowedFilter / AllowedSort API to Scout's search builder, letting you expose safe, declarative search endpoints driven by HTTP query parameters.
Credits — This package is a close adaptation of spatie/laravel-query-builder. All credit for the original architecture, patterns, and API design belongs to Spatie. If this package is useful to you, please consider supporting Spatie.
Documentation
- Filters
- Sorts
- Includes
- Pagination
- Engine Awareness
- Configuration
Installation
Publish the config file (optional):
Quick Start
Add the Searchable trait to your model as usual, then build a search endpoint:
This reads directly from the incoming $request:
| Parameter | Example |
|---|---|
| Search query | ?query=laravel |
| Exact filter | ?filter[status]=published |
| Multi-value filter | ?filter[tags]=php,laravel |
| Operator filter | ?filter[price]=gte:100 |
| Sort | ?sort=-recent,title |
| Paginate | ?page[number]=2&page[size]=15 |
Pagination
Use jsonPaginate() instead of get() to return a paginated result following the JSON:API page[number] / page[size] convention:
| Parameter | Example | Default |
|---|---|---|
| Page number | ?page[number]=2 |
1 |
| Page size | ?page[size]=15 |
30 |
The max page size is capped at 30 by default. Both defaults are configurable — see Pagination.
Wrapping an Existing Scout Builder
Facade
Differences from spatie/laravel-query-builder
| Feature | spatie/laravel-query-builder | foxws/laravel-scout-builder |
|---|---|---|
| Underlying builder | Eloquent Builder |
Scout Builder |
AllowedInclude |
✅ | ✅ via Scout query() callback (database/collection drivers) |
FiltersPartial, FiltersBeginsWith, etc. |
✅ | — (text search handled by Scout itself) |
AllowedFilter::operator() |
via FiltersOperator |
✅ first-class with FilterOperator enum |
AllowedFilter::dynamicOperator() |
— | ✅ colon-token + array payload |
AllowedFilter::notIn() |
— | ✅ |
AllowedSort::latest() / oldest() |
— | ✅ |
jsonPaginate() |
✅ (Eloquent only) | ✅ JSON:API page[number]/page[size] |
| Engine awareness | — | ✅ ScoutDriver + EngineFeature enums |
| Request scalar casting | raw strings | ✅ auto-casts 'true', '42', 'null', etc. |
Testing
Changelog
Please see CHANGELOG for more information on what has changed recently.
AI Assistance
This package is developed with AI assistance, primarily using GitHub Copilot and Claude Sonnet.
AI tools are used for suggestions and development acceleration. All final implementation decisions, code review, and adjustments are made by the maintainers. AI-generated contributions are welcome in pull requests, provided that a person is actively involved in the implementation and review process.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
- Spatie and all spatie/laravel-query-builder contributors — this package is built on their work
- francoism90
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-scout-builder with dependencies
laravel/scout Version ^10.0||^11.0
spatie/laravel-package-tools Version ^1.16
illuminate/contracts Version ^12.0||^13.0