Download the PHP package victormgomes/query-params without Composer
On this page you can find all versions of the php package victormgomes/query-params. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download victormgomes/query-params
More information about victormgomes/query-params
Files in victormgomes/query-params
Package query-params
Short Description Automatically generate query parameters from Eloquent models
License MIT
Homepage https://github.com/victormgomes/query-params
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 query-params
Query Params for Laravel
A powerful, zero-boilerplate package to handle complex API query parameters (filtering, sorting, field selection, relationship loading, and pagination) using native Laravel validation and optimized Eloquent queries.
🚀 Features
- Zero-Config Relations: Auto-maps
snake_casealiases and Foreign Keys for all Eloquent relationships. - Intelligent Queries: Automatically optimizes relationship filters to use FK columns for better DB performance.
- Strict Security: Native enforcement of Eloquent's
$visibleand$hiddenattributes. - Definitive Metadata: A specialized, deduplicated JSON structure for building dynamic frontend filters.
- Fancy URLs: Support for clean, "sentence-style" URL parameters.
- Native Validation: Auto-generates strict, type-safe Laravel validation rules from your database schema.
- Pluggable Drivers: Built-in support for complex field types like Translatable (JSON or Side-table).
📦 Installation
-
Install the package via composer:
- Publish the configuration file:
⚡ Quick Start
Simply add the #[MapQueryParams] attribute and the HasQueryParams trait to your FormRequest:
In your controller:
🛡️ Security & Visibility
The package strictly follows Laravel's internal visibility rules. Your API will never leak sensitive data because it respects:
$visible(Allow-list): If defined, only these fields will be exposed in metadata and available for query operations.$hidden(Deny-list): Fields in this array are strictly excluded from all operations.
🔗 Fancy URL Specification
The package supports "Sentence Style" parameters, allowing you to combine multiple operations into a single query key.
| Operation | URL Key | Fancy Sentence Format | Example |
|---|---|---|---|
| Filtering | filter |
field:operator:value |
?filter=name:like:Victor,active:true |
| Sorting | sort |
field:direction |
?sort=created_at:desc,name:asc |
| Fields | fields |
field1,field2 |
?fields=id,name,email |
| Includes | include |
relation1,relation2 |
?include=domains,active_tags |
| Pagination | page |
key:value |
?page=number:2,limit:50 |
Zero-Config Relationship Aliases
You don't need to worry about naming conventions. The package automatically discovers:
- Snake Case:
active_tagsin URL maps toactiveTags()in Model. - Foreign Keys:
people_idin URL maps topeople()relation. - Intelligent Filtering:
?filter=people:1is automatically optimized toWHERE people_id = 1.
Supported Filter Operators
| Operator | Description | URL Example |
|---|---|---|
eq |
Equal (Default) | status:active |
ne |
Not Equal | role:ne:admin |
like |
Case-sensitive search | name:like:John |
ilike |
Case-insensitive search | email:ilike:HOTMAIL |
gt / gte |
Greater than (or equal) | price:gt:100 |
lt / lte |
Less than (or equal) | age:lte:18 |
in / nin |
In list / Not in list | id:in:1,2,3 |
null / notnull |
Is Null / Is Not Null | deleted_at:null:true |
between |
Between two values | price:between:10,50 |
contains |
JSON/Array contains | tags:contains:urgent |
fts |
Full Text Search | content:fts:laravel |
🖥️ Frontend Dynamic Filters (Metadata)
The package provides a curated "Definitive Metadata" structure for frontend developers to build dynamic UI filters. It deduplicates aliases and only shows the most relevant names.
Example JSON Response:
🛠️ Advanced: Pluggable Drivers
Extend the package to handle custom database behaviors by defining a Resolver.
Your driver must implement the Victormgomes\QueryParams\Contracts\FieldResolver interface to handle custom filtering, sorting, and output transformation.
⚖️ License
The MIT License (MIT). Please see License File for more information.
All versions of query-params with dependencies
spatie/laravel-package-tools Version ^1.16
illuminate/contracts Version ^13.0
illuminate/support Version ^13.0
illuminate/database Version ^13.0
illuminate/http Version ^13.0