Download the PHP package leandroibarra/lumen-request-parser without Composer
On this page you can find all versions of the php package leandroibarra/lumen-request-parser. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download leandroibarra/lumen-request-parser
More information about leandroibarra/lumen-request-parser
Files in leandroibarra/lumen-request-parser
Package lumen-request-parser
Short Description A request query parameter parser for REST-APIs based on ngabor84/lumen-api-query-parser and for Laravel's Lumen framework.
License MIT
Informations about the package lumen-request-parser
Lumen request parser
Description
A request query parameter parser for REST-APIs based on ngabor84/lumen-api-query-parser and for Laravel's Lumen framework.
Requirements
- PHP >=8.1
- Lumen framework >= 10.0
Installation
-
Add leandroibarra/lumen-request-parser to your composer.json and make composer update, or just execute:
- Setup the service provider: in bootstrap/app.php add the following line:
Usage
Query syntax
Filtering
Request: /users?filter=first_name:ct:admin Response: Will return the collection of the users whose first names contains the admin string.
Available filter options
Operator | Description | Example |
---|---|---|
ct | String contains | name:ct:Peter |
nct | String NOT contains | name:nct:Peter |
sw | String starts with | username:sw:admin |
ew | String ends with | email:ew:gmail.com |
eq | Equals | level:eq:3 |
ne | Not equals | level:ne:4 |
gt | Greater than | level:gt:2 |
ge | Greater than or equal | level:ge:3 |
lt | Lesser than | level:lt:4 |
le | Lesser than or equal | level:le:3 |
in | In array | level:in:1|2|3 |
Ordering
Request: /users?sort=name,-email Response: Will return the collection of the users sort by their names ascending and by their email descending.
Pagination
Request: /users?page=3 Response: Will return the third page of the collection of users.
Pagination with page size (limit)
Request: /users?limit=50&page=2 Response: Will return a part of the collection of the users (from the 51st to 100th).