https://github.com/libgraviton/rql-parser

PHP RQL parser
https://github.com/libgraviton/rql-parser

fiql php rql rql-parser

Last synced: about 2 months ago
JSON representation

PHP RQL parser

• Host: GitHub
• URL: https://github.com/libgraviton/rql-parser
• Owner: libgraviton
• Created: 2015-04-13T18:01:56.000Z (over 9 years ago)
• Default Branch: develop
• Last Pushed: 2023-03-13T13:22:52.000Z (almost 2 years ago)
• Last Synced: 2024-11-07T13:49:12.544Z (about 2 months ago)
• Topics: fiql, php, rql, rql-parser
• Language: PHP
• Size: 197 KB
• Stars: 31
• Watchers: 5
• Forks: 15
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
RQL parser

==========

[![CI](https://github.com/libgraviton/rql-parser/actions/workflows/ci.yml/badge.svg)](https://github.com/libgraviton/rql-parser/actions/workflows/ci.yml)

![Packagist Version](https://img.shields.io/packagist/v/graviton/rql-parser)

![Packagist Downloads](https://img.shields.io/packagist/dt/graviton/rql-parser)

![Packagist License](https://img.shields.io/packagist/l/graviton/rql-parser)

This is a RQL parsing library written in PHP.

This library consists of the following parts:

 - lexer for tokenization RQL code

 - parser for creating abstract syntax tree

Installation

------------

The preferred way to install library is through [composer](http://getcomposer.org/download/).

Either run

```

composer require graviton/rql-parser

```

or add

```json

"graviton/rql-parser": "*",

```

to the require section of your `composer.json`.

Basic usage

-----------

```php

3&d>=string:4&e=eq=boolean:1))&u!=5&not(or(u=6,ge(i,10)))&z=1&(a==2|b<-3|in(c,(2,float:3)))&select(a,b)&sort(+a,-b)&limit(1,2)';

// tokenize RQL

$tokens = $lexer->tokenize($rql);

// parsing

var_dump($parser->parse($tokens));

```

See also [rql-command library](https://github.com/libgraviton/rql-command).

This is a console application to debug RQL lexing and parsing.

Advanced usage

--------------

See examples:

 - [Enable only FIQL operators](examples/01-only-fiql-operator.php)

 - [Add new query operators](examples/02-new-query-operator.php)

 - [Add support for aggregate functions](examples/03-new-top-operator.php)

 - [Convert RQL to SQL](examples/04-convert-to-sql.php)

 - [Add date support](examples/05-date-support.php)

 - [Use scalars in array nodes](examples/06-improve-array-parser.php)

 - [Add `timestamp` caster](examples/07-timestamp-caster.php)

 - [Wrap strings with quotes](examples/08-string-quoting.php)

Current state

-------------

### Operators ###

#### Basic syntax ####

 - scalar operators

    - `eq(a,b)`

    - `ne(a,b)`

    - `lt(a,b)`

    - `gt(a,b)`

    - `le(a,b)`

    - `ge(a,b)`

 - array operators

    - `in(a,(b,c))`

    - `out(a,(b,c))`

 - logic operators

    - `and(eq(a,b),ne(c,d))`

    - `or(eq(a,b),ne(c,d))`

    - `not(eq(a,b))`

#### Short logic syntax ####

 - `(eq(a,b)&ne(b,c))`

 - `(eq(a,b)|ne(b,c))`

#### FIQL syntax ####

 - scalar operators

    - `a=eq=b`

    - `a=ne=b`

    - `a=lt=b`

    - `a=gt=b`

    - `a=le=b`

    - `a=ge=b`

 - array operators

    - `a=in=(b,c)`

    - `a=out=(b,c)`

#### Simplified FIQL syntax ####

 - `a=b`

 - `a==b`

 - `a<>b`

 - `a!=b`

 - `ab`

 - `a<=b`

 - `a>=b`


#### Other ####

 - `select(a,b,c)`

 - `sort(+a,-b)`

 - `limit(1,2)`

All syntax variations may be used together.

### Value types ###

 

 - string

    - `abc`

    - `abc%20def`

 - integer

    - `1`, `+1`, `-1`

 - float

    - `1.`, `+1.`, `-1.`

    - `0.1`, `+0.1`, `-0.1`,

    - `0.1e5`, `+0.1e+5`, `-0.1e-5`

    - `.1`, `+.1`, `-.1`

    - `.1e5`, `+.1e+5`, `-.1e-5`

 - boolean

    - `true()`

    - `false()`

 - null

    - `null()`

 - empty

    - `empty()`

 - date

    - `2015-06-02T20:00:00Z`

 - glob

    - `abc*`

    - `?abc`

    - `abc*def?`

### Type casting ###

 - `string:1`

 - `boolean:0`

 - `integer:a`

 - `float:1`

Encoding rules

--------------

### String values ###

In string values all non-alphanumeric characters must be encoded with a percent (%) sign followed by two hex digits.

Examples:

```

eq(string,2015%2D05%2D30T15%3A10%3A00Z)

in(string,(%2B1%2E5,%2D1%2E5))

in(string,(null%28%29,empty%28%29,true%28%29,false%28%29))

```

#### String encoding in PHP: ####

```php

function encodeString($value)

{

    return strtr(rawurlencode($value), [

        '-' => '%2D',

        '_' => '%5F',

        '.' => '%2E',

        '~' => '%7E',

    ]);

}

```

#### String encoding in JavaScript: ####

```js

function encodeString(value) {

    return encodeURIComponent(value).replace(/[\-_\.~!\\'\*\(\)]/g, function (char) {

        return '%' + char.charCodeAt(0).toString(16).toUpperCase();

    });

}

```

### Other values ###

Date, number and const-function values must not be encoded.

Examples:

```

eq(date,2015-05-30T15:10:00Z)

in(number,(+1.5,-1.5))

in(const,(null(),empty(),true(),false()))

```

Resources

---------

 * [RQL Rules](https://github.com/persvr/rql)

 * [RQL documentation](https://doc.apsstandard.org/2.1/spec/rql)