leandrogehlen / yii2-querybuilder

Extension for Yii2 Framework to work with jQuery QueryBuilder

jQuery QueryBuilder Extension for Yii 2

This is the jQuery QueryBuilder extension for Yii 2. It encapsulates QueryBuilder component in terms of Yii widgets, and thus makes using QueryBuilder component in Yii applications extremely easy

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist leandrogehlen/yii2-querybuilder "*"

or add

"leandrogehlen/yii2-querybuilder": "*"

to the require section of your composer.json file.

How to use

The extension depends the bootstrap css then is necessary adds it in AppAsset:

class AppAsset extends AssetBundle {

    ...

    public $depends = [
        ...
        'yii\bootstrap\BootstrapAsset', // or 'yii\bootstrap4\BootstrapAsset'
    ];

}

View:

use leandrogehlen\querybuilder\QueryBuilderForm;

<?php QueryBuilderForm::begin([
    'rules' => $rules,
    'builder' => [
        'id' => 'query-builder',
        'pluginOptions' => [
            'filters' => [
                ['id' => 'id', 'label' => 'Id', 'type' => 'integer'],
                ['id' => 'name', 'label' => 'Name', 'type' => 'string'],
                ['id' => 'lastName', 'label' => 'Last Name', 'type' => 'string']
            ]
        ]
    ]
 ])?>

    <?= Html::submitButton('Apply'); ?>
    <?= Html::resetButton('Reset'); ?>

<?php QueryBuilderForm::end() ?>

Controller:

use leandrogehlen\querybuilder\Translator;

public function actionIndex()
{
    $query = Customer::find();
    $rules = Json::decode(Yii::$app->request->get('rules'));
    if ($rules) {
        $translator = new Translator($rules);
        $query->andWhere($translator->where())
              ->addParams($translator->params());
    }

    $dataProvider = new ActiveDataProvider([
        'query' => $query,
    ]);

    return $this->render('index', [
        'dataProvider' => $dataProvider,
        'rules' => $rules
    ]);
}

yii2-querybuilder's Issues

use of Plugins

Hi,
is there a way to use the plugins, i.e. slider, selectize and datepicker. Just tried and don't get it how to use them.

would be very nice, i need this components for my actual project.

with kind regards

peter

Custom Input

How do I implement the custom input in the filter? Do I pass in a php function or a string jquery function?

save definition of created query

Hi,

any plans to allow a "save" of the query beeing created by the user?

Thanks - Philipp

composer error

Hi

i am getting an error while doing composer update
The "https://bower.herokuapp.com/packages/search/jquery-querybuilder" file could not be downloaded (HTTP/1.1 404 Not Found)

If i remove yii2-querybuilder from composer.json - all the rest of dependencies work fine.
yii2-querybuilder is added in composer.json as "leandrogehlen/yii2-querybuilder": "*"

tried on also on a second (live) machine that should work fine otherwise and got the same result.

any ideas?

Update to jQuery QueryBuilder 2.1.0

is there a chance any time soon there will be an update to the latest version of jQuery Query Builder?

Replace Object with BaseObject

Since in PHP7 'Object' becase a reserved keyword.
Need to update all classes inherited from yii\base\Object, to make them inherited from yii\base\BaseObject

Feature request: multiple queries merged

Hi,

I'd like to propose an additional feature.

I have a situation where I need to add multiple query-builder objects into one query.
But what happens now is that the params in the Query are shared. I have code like that:

$query = new Query;
foreach ($my->usedFilters as $qhf) {
    $rules = Json::decode($qhf->questionFilter->filter);
    $translator = new Translator($rules);
    $query
            ->andWhere($translator->where())
            ->addParams($translator->params());
}

What happens here is that the params in Query is for the whole query. With each loop the params will be reassigned as p0, p1 .. pn and with each loop they get overwritten.

So I am thinking that the Translator could have something like setCurrentParams($params) where you could set the already assigned params and the next ones would be added on top rather than overwritten.

so we would have code like that for my implementation

$query = new Query;
foreach ($my->usedFilters as $qhf) {
    $rules = Json::decode($qhf->questionFilter->filter);
    $translator = new Translator($rules);
    $translator->setCurrentParams($query->params);
    $query
            ->andWhere($translator->where())
            ->addParams($translator->params());
}

Cannot install the package

$ composer require leandrogehlen/yii2-querybuilder "*"

[UnexpectedValueException]
Could not parse version constraint >=~2: Invalid version string "~2"

bower asset jQuery-QueryBuilder case mismatch

jQuery-QueryBuilder should be small letter to load bower-assets. it wont work in linux env. bower asset creates directory in small letter

it should be public $sourcePath = '@bower/jquery-querybuilder/dist';

yii2-querybuilder/QueryBuilderAsset.php

Line 14 in 666d0f3

public $sourcePath = '@bower/jQuery-QueryBuilder/dist';

Question: is there a reason that rules isn't passed directly by pluginOptions?

Hi i have seen your extension for the JQueryBuilder and have one Question.

Is there a reason that you pass the $rules to the QueryBuilderForm and not add it to the pluginOptions directly?

<?php QueryBuilderForm::begin([
    'rules' => $rules,
    'builder' => [
        'id' => 'query-builder',
        'pluginOptions' => [
            'filters' => [
                ['id' => 'id', 'label' => 'Id', 'type' => 'integer'],
                ['id' => 'name', 'label' => 'Name', 'type' => 'string'],
                ['id' => 'lastName', 'label' => 'Last Name', 'type' => 'string']
            ]
        ]
    ]
])?>

Which would then add JS code to set the rules.

instead of set it directly?

<?php QueryBuilderForm::begin([
    'builder' => [
        'id' => 'query-builder',
        'pluginOptions' => [
            'rules' => $rules,
            'filters' => [
                ['id' => 'id', 'label' => 'Id', 'type' => 'integer'],
                ['id' => 'name', 'label' => 'Name', 'type' => 'string'],
                ['id' => 'lastName', 'label' => 'Last Name', 'type' => 'string']
            ]
        ]
    ]
])?>

I mean you even didn't use the $rules given to the QueryBuilderForm e.g. add the json version already to the echo Html::hiddenInput($this->rulesParam); as value?