andmemasin / query-builder

0.2.0 2026-11-11 15:37 UTC

Requires

• php: >=8.2

Requires (Dev)

• phpstan/phpstan: ^2.0
• phpunit/phpunit: ^11.0

MIT

• sql
• filter
• rules
• query builder
• web component

Published on Packagist.org on 2026-11-11 15:55 UTC

README

Framework-free query rules for PHP and the browser.

• PHP: turn rules JSON into a SQL WHERE clause with named parameters for PDO.
• Browser: <query-builder>, a web component to edit the rules, shipped prebuilt in dist/.

The rules JSON is compatible with jQuery QueryBuilder's format. See docs/design.md.

composer require andmemasin/query-builder

PHP

use Andmemasin\QueryBuilder\Translator;

$rules = json_decode($json, true);
$translator = new Translator($rules, 'p', Translator::quoteMysqlIdentifier(...));

$stmt = $pdo->prepare('SELECT * FROM people WHERE ' . $translator->where());
$stmt->execute($translator->params());

Browser

Load dist/query-builder.js (one self-contained ES module, no build needed) and put the element in a form:

<script type="module" src="/assets/query-builder.js"></script>

<form method="post">
  <query-builder name="rules"
    filters='[{"id":"age","label":"Age","type":"integer"},{"id":"name","label":"Name","type":"string"}]'
    rules='{"condition":"AND","rules":[{"id":"age","field":"age","type":"integer","input":"number","operator":"greater","value":18}]}'>
  </query-builder>
</form>

The form submits the rules JSON under name. From script: element.value (rules JSON with valid), element.valid, and a change event with detail: {rules, valid}. Add the readonly attribute (or set element.readonly = true) to show the rules as compact text without editing controls. Colours can be themed with --qb-* CSS custom properties. See demo/index.html.

Development: npm install, npm test (builds dist/ and runs the node tests); PHP tests with vendor/bin/phpunit.

License: MIT.