Download the PHP package ngekoding/codeigniter-api-query-parser without Composer
On this page you can find all versions of the php package ngekoding/codeigniter-api-query-parser. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download ngekoding/codeigniter-api-query-parser
More information about ngekoding/codeigniter-api-query-parser
Files in ngekoding/codeigniter-api-query-parser
Package codeigniter-api-query-parser
Short Description A query parser for REST-APIs based on CodeIgniter
License MIT
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 codeigniter-api-query-parser
CodeIgniter API Query Parser
Simple request query parameter parser for REST-APIs based on CodeIgniter framework. Works for both CodeIgniter 3 and CodeIgniter 4.
Inspired by Lumen API Query Parser
Requirements
- PHP 5.6 or above
- CodeIgniter 3 or CodeIgniter 4
- PHPSQLParser ^4.5
Installation
You just need to use composer and everything is done.
Usage
Here is the example for CodeIgniter 3 and CodeIgniter 4. Actually there is no different by the use of the library, just different how to create the query builder.
CodeIgniter 3 Example
The above example will output an array with data and pagination:
CodeIgniter 4 Example
The different only by the way to create the Query Builder.
Query Syntax
Filtering
Q: /users?filter[]=name:ct:admin
R: will return the array 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 | Less than | level:lt:4 |
| le | Less than or equal | level:le:3 |
| in | In array | level:in:1,2,3 |
Sorting
Q: /users?sort[]=name:ASC
R: will return the array of the users sort by their names ascending
Pagination
Q: /users?limit=10&page=3
R: will return a part of the array of the users (from the 21st to 30th)
Column Alias
When working with SQL expression in selecting data or using join with ambiguous column name, the library automatically will try to find the original column name or its expression to use for the filter feature. But, you can still manually define the column alias for better use, expecially to resolving the ambiguous column name when using join.
For example, joining posts table with categories table in the example above will return an id from the posts table. So, when we try to get the data with id 1, 2 or 3 (SQL WHERE IN) using filter[]=id:in:1,2,3 we get the ambiguous column error.
Here is the column alias to solve it.
