Documentation

ExpressionBuilder
in package

Application

ExpressionBuilder class is responsible to dynamically create SQL query parts.

EQ


    public
    mixed
    EQ
    = '='

GT


    public
    mixed
    GT
    = '>'

GTE


    public
    mixed
    GTE
    = '>='

LT


    public
    mixed
    LT
    = '<'

LTE


    public
    mixed
    LTE
    = '<='

NEQ


    public
    mixed
    NEQ
    = '<>'

$connection

The DBAL Connection.


    private
        Connection
    $connection

__construct()

Initializes a new <tt>ExpressionBuilder</tt>.


    public
                __construct(Connection $connection) : mixed

Parameters

$connection : Connection: The DBAL Connection.

Return values

mixed —

andX()

Creates a conjunction of the given boolean expressions.


    public
                andX([mixed $x = null ]) : CompositeExpression

Example:

[php] // (u.type = ?) AND (u.role = ?) $expr->andX('u.type = ?', 'u.role = ?'));

Parameters

$x : mixed = null: Optional clause. Defaults = null, but requires at least one defined when converting to string.

Return values

CompositeExpression —

comparison()

Creates a comparison expression.


    public
                comparison(mixed $x, string $operator, mixed $y) : string

Parameters

$x : mixed: The left expression.
$operator : string: One of the ExpressionBuilder::* constants.
$y : mixed: The right expression.

Return values

string —

eq()

Creates an equality comparison expression with the given arguments.


    public
                eq(mixed $x, mixed $y) : string

First argument is considered the left expression and the second is the right expression. When converted to string, it will generated a = . Example:

[php]
// u.id = ?
$expr->eq('u.id', '?');

Parameters

$x : mixed: The left expression.
$y : mixed: The right expression.

Return values

string —

gt()

Creates a greater-than comparison expression with the given arguments.


    public
                gt(mixed $x, mixed $y) : string

First argument is considered the left expression and the second is the right expression. When converted to string, it will generated a > . Example:

[php]
// u.id > ?
$q->where($q->expr()->gt('u.id', '?'));

Parameters

$x : mixed: The left expression.
$y : mixed: The right expression.

Return values

string —

gte()

Creates a greater-than-equal comparison expression with the given arguments.


    public
                gte(mixed $x, mixed $y) : string

First argument is considered the left expression and the second is the right expression. When converted to string, it will generated a >= . Example:

[php]
// u.id >= ?
$q->where($q->expr()->gte('u.id', '?'));

Parameters

$x : mixed: The left expression.
$y : mixed: The right expression.

Return values

string —

in()

Creates a IN () comparison expression with the given arguments.


    public
                in(string $x, string|array<string|int, mixed> $y) : string

Parameters

$x : string: The field in string format to be inspected by IN() comparison.
$y : string|array<string|int, mixed>: The placeholder or the array of values to be used by IN() comparison.

Return values

string —

isNotNull()

Creates an IS NOT NULL expression with the given arguments.


    public
                isNotNull(string $x) : string

Parameters

$x : string: The field in string format to be restricted by IS NOT NULL.

Return values

string —

isNull()

Creates an IS NULL expression with the given arguments.


    public
                isNull(string $x) : string

Parameters

$x : string: The field in string format to be restricted by IS NULL.

Return values

string —

like()

Creates a LIKE() comparison expression with the given arguments.


    public
                like(string $x, mixed $y) : string

Parameters

$x : string: Field in string format to be inspected by LIKE() comparison.
$y : mixed: Argument to be used in LIKE() comparison.

Return values

string —

literal()

Quotes a given input parameter.


    public
                literal(mixed $input[, string|null $type = null ]) : string

Parameters

$input : mixed: The parameter to be quoted.
$type : string|null = null: The type of the parameter.

Return values

string —

lt()

Creates a lower-than comparison expression with the given arguments.


    public
                lt(mixed $x, mixed $y) : string

First argument is considered the left expression and the second is the right expression. When converted to string, it will generated a < . Example:

[php]
// u.id < ?
$q->where($q->expr()->lt('u.id', '?'));

Parameters

$x : mixed: The left expression.
$y : mixed: The right expression.

Return values

string —

lte()

Creates a lower-than-equal comparison expression with the given arguments.


    public
                lte(mixed $x, mixed $y) : string

First argument is considered the left expression and the second is the right expression. When converted to string, it will generated a <= . Example:

[php]
// u.id <= ?
$q->where($q->expr()->lte('u.id', '?'));

Parameters

$x : mixed: The left expression.
$y : mixed: The right expression.

Return values

string —

neq()

Creates a non equality comparison expression with the given arguments.


    public
                neq(mixed $x, mixed $y) : string

First argument is considered the left expression and the second is the right expression. When converted to string, it will generated a <> . Example:

[php]
// u.id <> 1
$q->where($q->expr()->neq('u.id', '1'));

Parameters

$x : mixed: The left expression.
$y : mixed: The right expression.

Return values

string —

notIn()

Creates a NOT IN () comparison expression with the given arguments.


    public
                notIn(string $x, string|array<string|int, mixed> $y) : string

Parameters

$x : string: The field in string format to be inspected by NOT IN() comparison.
$y : string|array<string|int, mixed>: The placeholder or the array of values to be used by NOT IN() comparison.

Return values

string —

notLike()

Creates a NOT LIKE() comparison expression with the given arguments.


    public
                notLike(string $x, mixed $y) : string

Parameters

$x : string: Field in string format to be inspected by NOT LIKE() comparison.
$y : mixed: Argument to be used in NOT LIKE() comparison.

Return values

string —

orX()

Creates a disjunction of the given boolean expressions.


    public
                orX([mixed $x = null ]) : CompositeExpression

Example:

[php] // (u.type = ?) OR (u.role = ?) $qb->where($qb->expr()->orX('u.type = ?', 'u.role = ?'));

Parameters

$x : mixed = null: Optional clause. Defaults = null, but requires at least one defined when converting to string.

Return values

CompositeExpression —