引力子/rql-parser-bundle

php-rql-parser在Symfony世界中的端口

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

README

Build Status Scrutinizer Code Quality Code Coverage Latest Stable Version Total Downloads Latest Unstable Version License

为graviton/php-rql-parser提供的Symfony 2扩展包。

此包遵循SemVer版本控制。

它使用git-flow的github版本,其中新功能和错误修复必须通过github pull request合并到开发分支。它使用标准的git-flow命名约定,并在版本标签前添加了'v'前缀。

由于底层库正在积极开发中,因此此包也被视为不稳定。有关的更多当前状态信息,请参阅。

安装

步骤 1: 下载包

打开命令行控制台,进入您的项目目录,并执行以下命令以下载此包的最新稳定版本

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

此命令需要您全局安装了Composer,如Composer文档中的安装章节所述。

步骤 2: 启用包

然后,通过在您的项目中的app/AppKernel.php文件中添加以下行来启用包

<?php
// app/AppKernel.php

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

            new Graviton\RqlParserBundle\GravitonRqlParserBundle(),
        );

        // ...
    }

    // ...
}

如何使用

尽管存在单元测试,这些测试已经是使用工厂的示例,但以下示例显示了如何使用它

[...]

class FooController {

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

            // do something with the query.
        }
    }
}

[...]