graviton/rql-parser-bundle

Port of the php-rql-parser into the world of Symfony

v4.0.0 2024-08-08 05:55 UTC

Requires

• graviton/php-rql-parser: ^5.0
• symfony/config: >=6.4.0
• symfony/dependency-injection: >=6.4.0
• symfony/http-foundation: >=6.4.0
• symfony/http-kernel: >=6.4.0

Requires (Dev)

• doctrine/mongodb-odm: @stable
• libgraviton/codesniffer: ~2
• phpunit/phpunit: ^9.0
• squizlabs/php_codesniffer: ~3

MIT

• List of contributors

README

Symfony 2 bundle to the graviton/php-rql-parser.

This package adheres to SemVer versioning.

It uses a github version of git-flow in which new features and bugfixes must be merged to develop using a github pull request. It uses the standard git-flow naming conventions with the addition of a 'v' prefix to version tags.

Since the underlying library is under heavy development, this bundle is considered unstable, too. Please refer to the library for more information about the current state.

Installation

Step 1: Download the Bundle

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

composer require "graviton/rql-parser-bundle": "dev-master"

This command requires you to have Composer installed globally, as explained in the installation chapter of the Composer documentation.

Step 2: Enable the Bundle

Then, enable the bundle by adding the following line in the app/AppKernel.php file of your project:

<?php
// app/AppKernel.php

// ...
class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = array(
            // ...

            new Graviton\RqlParserBundle\GravitonRqlParserBundle(),
        );

        // ...
    }

    // ...
}

How to use

Despite the existence of unit tests, which are already examples how to use the factory, the following example shows it:

[...]

class FooController {

    public function searchSomething(Request $request) {
    
        if ($request->attributes('hasRql', false)) {
            $query = $request->attributes->get('rqlQuery');

            // do something with the query.
        }
    }
}

[...]