netzmacht/contao-query-builder

Contao query builder based on Aura/SQL_Query

Contao Query builder

, _(*1)

This extension provides a query builder based on the aura/sqlquery., _(*2)

Install

You can install this library using Composer. It requires at least PHP 5.5 and Contao 3.2., _(*3)

$ php composer.phar require netzmacht/contao-query-builder:~1.0

Documentation

Please refer to the aura/sqlquery documentation to understand the basic usage., _(*4)

The Contao integration adds easy execution of the created statements and DI integration using c-c-a/dependency-container., _(*5)

Basic usage, _(*6)

<?php

$factory = $GLOBALS['container']['query-builder.factory'];

// Creates insert query implementing interface Netzmacht\Contao\QueryBuilder\Query\Insert
$insert  = $factory->newInsert();

// Creates insert query implementing interface Netzmacht\Contao\QueryBuilder\Query\Update
$update  = $factory->newUpdate();

// Creates insert query implementing interface Netzmacht\Contao\QueryBuilder\Query\Select
$select  = $factory->newSelect();

// Creates insert query implementing interface Netzmacht\Contao\QueryBuilder\Query\Delete
$delete  = $factory->newDelete();

// Executing the statement
$result = $statement->execute();

Extended features

Though this extension is based on aura/sqlquery it provides some extra features., _(*7)

Query conditions, _(*8)

If you have complex where conditions you can pass an callback which generates a separate condition object., _(*9)

<?php

// Generates "category = 2 AND (date > ? OR highlighted = 1)"
$query
    ->where('category = 2')
    ->where(
        function (Netzmacht\Contao\QueryBuilder\Condition $condition) {
            $condition->orWhere('date > ?', time());
            $condition->orWhere('highlighted = 1');
        }
    );

Where in statements, _(*10)

As Contao does not use PDO as driver you have to manually create whereIn statements. So that whereIn and orWhereIn are provided for queries and for the conditions., _(*11)

<?php

// Generates "category = 2 AND (date > ? OR highlighted = 1)"
$query
    ->whereIn('category', [2, 3])
    ->whereIn('author', [3, 4, 2]);

Differences

Though you can use named bind values the generated statement does only contain ? placeholders as Contao only support these., _(*12)