Download the PHP package ionext/laravel-api-query-parser without Composer
On this page you can find all versions of the php package ionext/laravel-api-query-parser. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download ionext/laravel-api-query-parser
More information about ionext/laravel-api-query-parser
Files in ionext/laravel-api-query-parser
Package laravel-api-query-parser
Short Description A query parser for REST-APIs based on the laravel framework
License MIT
Homepage https://github.com/ionext/laravel-api-query-parser
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-api-query-parser
Laravel API query parser
Description
This is a simple request query parameter parser for REST-APIs based on Laravel's framework.
Requirements
- PHP >=7.2
- Laravel framework >= 6.2
- Mockery >= 1.3 (dev)
- PHPUnit >= 8.4 (dev)
Installation
- Add ionext/laravel-api-query-parser to your composer.json and make composer update, or composer require ionext/laravel-api-query-parser
- Setup the service provider: in config/app.php add the following line:
Usage
Query syntax
Eager loading
Q: /users?connection[]=profile
R: will return the collection of the users with their profiles included
Filtering
Q: /users?filter[]=name:ct:admin
R: will return the collection of the users whose 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 |
| nin | Not in array | level:nin:1|2|3 |
Note on filtering based on relational values
It is now possible to filter based on relational values using the table.column notation. eg. comments.author:eq:mike
Locating
Q: /users?location=longitude_field:latitude_field:0.000000:0.000000:10 R: This requires the user to have longitude and latitude fields. It will return the collection of the users within a given (10km) radius from the provided latitude and longitude. The distance to each entity will be passed via a custom distance column. When using location, a simple paginator will be used due to a bug in Laravel. This means the last page will be null.
Advanced location, joining tables
Q: /users?location=longitude_field:latitude_field:0.000000:0.000000:10:offices|office_id R: Notice the last parameter separated by a pipe(|). This allows joining another table on containing the latitude and longitude information, adding location_id, latitude and longitude fields to the final result.
Sorting
Q: /users?sort[]=name:ASC
R: will return the collection of the users sort by their names ascending
Pagination
Q: /users?limit=10&page=3
R: will return a part of the collection of the users (from the 21st to 30th)
Credits
Package was originally developed by Gábor Németh (github: https://github.com/ngabor84) for Laravel Lumen(https://github.com/ngabor84/lumen-api-query-parser). The realisation of this package required some refactoring to be used with Laravel.
