Download the PHP package khalyomede/odata-query-parser without Composer
On this page you can find all versions of the php package khalyomede/odata-query-parser. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download khalyomede/odata-query-parser
More information about khalyomede/odata-query-parser
Files in khalyomede/odata-query-parser
Package odata-query-parser
Short Description Parse OData v4 query strings.
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 odata-query-parser
Unmaintained notice
Be aware I am not longer able to provide updates regularily. Please check this repository for a more up-to-date version: https://github.com/Globy-App/odata-query-parser.
odata-query-parser
Parse OData v4 query strings.
Summary
- About
- Features
- Requirements
- Installation
- Examples
- API
- Known issues
About
I needed to only parse query strings to convert OData v4 commands into an understandable array that I could use to make a Laravel package to offer a way to automatically use Eloquent to filter the response according to this parsed array of OData v4 command.
As I did not see a package exclusively dealing with parsing the query strings, and saw that some people worked on their own without open sourcing it, I decided I would start one myself.
Features
- Parses an URL and returns an array
- Supports
$select,$top,$skip,$orderby,$count - Partial support for
$filter(see Known issues section) - You can use a parse mode that let you parse these keywords without prepending
$
Requirements
- PHP >= 7.2.0
- Composer
Installation
Add the package to your dependencies:
Examples
- 1. Use \$select to filter on some fields
- 2. Use non dollar syntax
1. Use \$select to filter on some fields
In this example, we will use the $select OData query string command to filter the fields returned by our API.
If you inspect $data, this is what you will get:
2. Use non dollar syntax
In this example, we will use a unique feature of this library: to be able to not specify any dollar, while still being able to use the OData v4 URL query parameter grammar.
If you inspect $data, this is what you will get:
API
parameters
- string
$url: The URL to parse the query strings from. It should be a "complete" or "full" URL, which means thathttp://example.comwill pass whileexample.comwill not pass - bool
$withDollar: Set it to false if you want to parse query strings without having to add the$signs before each keys.
returns
An associative array:
throws
InvalidArgumentException- If the parameter
$urlis not a valid URL (see the parameter description to know what is a valid URL) - If the
$topquery string value is not an integer - If the
$topquery string value is lower than 0 - If the
$skipquery string value is not an integer - If the
$skipquery string value is lower than 0 - If the direction of the
$orderbyquery string value is neitherascordesc
- If the parameter
Known issues
$filtercommand will not parseorand functions (likecontains()ofsubstringof), because I did not focused on this for the moment (the parser for$filteris too simplist, I should find a way to create an AST).
