tflori/orm

» API Reference » ORM\QueryBuilder\QueryBuilderInterface

ORM\QueryBuilder\QueryBuilderInterface

Table of Contents

• Abstract
• Constants
• Methods
  • $queryBuilderInterface->andParenthesis - Add a parenthesis with AND
  • $queryBuilderInterface->andWhere - Add a where condition with AND.
  • $queryBuilderInterface->close - Close parenthesis
  • $queryBuilderInterface->column - Add $column
  • $queryBuilderInterface->columns - Set $columns
  • $queryBuilderInterface->fullJoin - Full (outer) join $tableName with $options
  • $queryBuilderInterface->getExpression - Get the expression
  • $queryBuilderInterface->getQuery - Get the query / select statement
  • $queryBuilderInterface->groupBy - Group By $column
  • $queryBuilderInterface->join - (Inner) join $tableName with $options
  • $queryBuilderInterface->leftJoin - Left (outer) join $tableName with $options
  • $queryBuilderInterface->limit - Set $limit
  • $queryBuilderInterface->modifier - Add $modifier
  • $queryBuilderInterface->offset - Set $offset
  • $queryBuilderInterface->orderBy - Order By $column in $direction
  • $queryBuilderInterface->orParenthesis - Add a parenthesis with OR
  • $queryBuilderInterface->orWhere - Add a where condition with OR.
  • $queryBuilderInterface->orWhereIn - Add a where in condition with OR.
  • $queryBuilderInterface->orWhereNotIn - Add a where not in condition with OR.
  • $queryBuilderInterface->parenthesis - Alias for andParenthesis
  • $queryBuilderInterface->rightJoin - Right (outer) join $tableName with $options
  • $queryBuilderInterface->where - Alias for andWhere
  • $queryBuilderInterface->whereIn - Add a where in condition with AND.
  • $queryBuilderInterface->whereNotIn - Add a where not in condition with AND.

Abstract

Extends: ORM\QueryBuilder\ParenthesisInterface

Interface QueryBuilderInterface

Constants

Methods

ORM\QueryBuilder\QueryBuilderInterface::andParenthesis

public function andParenthesis(): $this

Add a parenthesis with AND

ORM\QueryBuilder\QueryBuilderInterface::andParenthesis

↑ top

ORM\QueryBuilder\QueryBuilderInterface::andWhere

public function andWhere(
    string $column, 
    string|array $operator = '', 
    string $value = '', 
): $this

Add a where condition with AND.

QueryBuilderInterface andWhere($column[, $operator[, $value]]);

If $column has the same amount of question marks as $value - $value is the second parameter.

If there is no third parameter and no question mark in $column then the default operator is ‘=’ and $value is the second parameter.

These calls are equal:

$query->andWhere('name', '=' , 'John Doe');
$query->andWhere('name = ?', 'John Doe');
$query->andWhere('name', 'John Doe');
$query->andWhere('name = ?', ['John Doe']);

Parameters

ORM\QueryBuilder\QueryBuilderInterface::andWhere

↑ top

ORM\QueryBuilder\QueryBuilderInterface::close

public function close(
    , 
): \ORM\QueryBuilder\QueryBuilderInterface|\ORM\QueryBuilder\ParenthesisInterface

Close parenthesis

ORM\QueryBuilder\QueryBuilderInterface::close

↑ top

ORM\QueryBuilder\QueryBuilderInterface::column

public function column(
    string $column, 
    array $args = [], 
    string $alias = '', 
): $this

Add $column

Optionally you can provide an expression with question marks as placeholders filled with $args.

Parameters

ORM\QueryBuilder\QueryBuilderInterface::column

↑ top

ORM\QueryBuilder\QueryBuilderInterface::columns

public function columns(array|null $columns = null): $this

Set $columns

Parameters

ORM\QueryBuilder\QueryBuilderInterface::columns

↑ top

ORM\QueryBuilder\QueryBuilderInterface::fullJoin

public function fullJoin(
    string $tableName, 
    string|bool $expression = '', 
    string $alias = '', 
    array $args = [], 
): $this|\ORM\QueryBuilder\ParenthesisInterface

Full (outer) join $tableName with $options

When no expression got provided self get returned. If you want to get a parenthesis the parameter empty can be set to false.

ATTENTION: here the default value of empty got changed - defaults to yes

Parameters

ORM\QueryBuilder\QueryBuilderInterface::fullJoin

↑ top

ORM\QueryBuilder\QueryBuilderInterface::getExpression

public function getExpression(): string

Get the expression

Returns the complete expression inside this parenthesis.

ORM\QueryBuilder\QueryBuilderInterface::getExpression

↑ top

ORM\QueryBuilder\QueryBuilderInterface::getQuery

public function getQuery(): string

Get the query / select statement

Builds the statement from current where conditions, joins, columns and so on.

ORM\QueryBuilder\QueryBuilderInterface::getQuery

↑ top

ORM\QueryBuilder\QueryBuilderInterface::groupBy

public function groupBy(string $column, array $args = []): $this

Group By $column

Optionally you can provide an expression in $column with question marks as placeholders.

Parameters

ORM\QueryBuilder\QueryBuilderInterface::groupBy

↑ top

ORM\QueryBuilder\QueryBuilderInterface::join

public function join(
    string $tableName, 
    string|bool $expression = '', 
    string $alias = '', 
    array $args = [], 
): $this|\ORM\QueryBuilder\ParenthesisInterface

(Inner) join $tableName with $options

When no expression got provided a ParenthesisInterface get returned. If this parenthesis not get filled you will most likely get an error from your database. If you don’t want to get a parenthesis the parameter empty can be set to true.

Parameters

ORM\QueryBuilder\QueryBuilderInterface::join

↑ top

ORM\QueryBuilder\QueryBuilderInterface::leftJoin

public function leftJoin(
    string $tableName, 
    string|bool $expression = '', 
    string $alias = '', 
    array $args = [], 
): $this|\ORM\QueryBuilder\ParenthesisInterface

Left (outer) join $tableName with $options

When no expression got provided a ParenthesisInterface get returned. If this parenthesis not get filled you will most likely get an error from your database. If you don’t want to get a parenthesis the parameter empty can be set to true.

Parameters

ORM\QueryBuilder\QueryBuilderInterface::leftJoin

↑ top

ORM\QueryBuilder\QueryBuilderInterface::limit

public function limit(int $limit): $this

Set $limit

Limits the amount of rows fetched from database.

Parameters

ORM\QueryBuilder\QueryBuilderInterface::limit

↑ top

ORM\QueryBuilder\QueryBuilderInterface::modifier

public function modifier(string $modifier): $this

Add $modifier

Add query modifiers such as SQL_CALC_FOUND_ROWS or DISTINCT.

Parameters

ORM\QueryBuilder\QueryBuilderInterface::modifier

↑ top

ORM\QueryBuilder\QueryBuilderInterface::offset

public function offset(int $offset): $this

Set $offset

Changes the offset (only with limit) where fetching starts in the query.

Parameters

ORM\QueryBuilder\QueryBuilderInterface::offset

↑ top

ORM\QueryBuilder\QueryBuilderInterface::orderBy

public function orderBy(
    string $column, 
    string $direction = self::DIRECTION_ASCENDING, 
    array $args = [], 
): $this

Order By $column in $direction

Optionally you can provide an expression in $column with question marks as placeholders.

Parameters

ORM\QueryBuilder\QueryBuilderInterface::orderBy

↑ top

ORM\QueryBuilder\QueryBuilderInterface::orParenthesis

public function orParenthesis(): $this

Add a parenthesis with OR

ORM\QueryBuilder\QueryBuilderInterface::orParenthesis

↑ top

ORM\QueryBuilder\QueryBuilderInterface::orWhere

public function orWhere(
    string $column, 
    string|array $operator = '', 
    string $value = '', 
): $this

Add a where condition with OR.

QueryBuilderInterface orWhere($column[, $operator[, $value]]);

If $column has the same amount of question marks as $value - $value is the second parameter.

If there is no third parameter and no question mark in $column then the default operator is ‘=’ and $value is the second parameter.

These calls are equal:

$query->orWhere('name', '=' , 'John Doe');
$query->orWhere('name = ?', 'John Doe');
$query->orWhere('name', 'John Doe');
$query->orWhere('name = ?', ['John Doe']);

Parameters

ORM\QueryBuilder\QueryBuilderInterface::orWhere

↑ top

ORM\QueryBuilder\QueryBuilderInterface::orWhereIn

public function orWhereIn(string|array $column, array $values): $this

Add a where in condition with OR.

If $column is an array a composite where in statement will be created

Example: whereIn(['a', 'b'], [[42, 23], [42, 23]]) gets (a,b) IN ((42,23), (23,42)) in mysql

If $values is empty the expression will be 1 = 0 because an empty parenthesis causes an error in SQL.

Parameters

ORM\QueryBuilder\QueryBuilderInterface::orWhereIn

↑ top

ORM\QueryBuilder\QueryBuilderInterface::orWhereNotIn

public function orWhereNotIn(string|array $column, array $values): $this

Add a where not in condition with OR.

If $column is an array a composite where in statement will be created

Example: whereIn(['a', 'b'], [[42, 23], [42, 23]]) gets (a,b) NOT IN ((42,23), (23,42)) in mysql

If $values is empty the expression will be 1 = 1 because an empty parenthesis causes an error in SQL.

Parameters

ORM\QueryBuilder\QueryBuilderInterface::orWhereNotIn

↑ top

ORM\QueryBuilder\QueryBuilderInterface::parenthesis

public function parenthesis(): $this

Alias for andParenthesis

See Also:

• ORM\QueryBuilder\ParenthesisInterface::andWhere()

ORM\QueryBuilder\QueryBuilderInterface::parenthesis

↑ top

ORM\QueryBuilder\QueryBuilderInterface::rightJoin

public function rightJoin(
    string $tableName, 
    string|bool $expression = '', 
    string $alias = '', 
    array $args = [], 
): $this|\ORM\QueryBuilder\ParenthesisInterface

Right (outer) join $tableName with $options

When no expression got provided a ParenthesisInterface get returned. If this parenthesis not get filled you will most likely get an error from your database. If you don’t want to get a parenthesis the parameter empty can be set to true.

Parameters

ORM\QueryBuilder\QueryBuilderInterface::rightJoin

↑ top

ORM\QueryBuilder\QueryBuilderInterface::where

public function where(
    string $column, 
    mixed $operator = '', 
    mixed $value = '', 
): $this

Alias for andWhere

QueryBuilderInterface where($column[, $operator[, $value]]);

If $column has the same amount of question marks as $value - $value is the second parameter.

If there is no third parameter and no question mark in $column then the default operator is ‘=’ and $value is the second parameter.

These calls are equal:

$query->where('name', '=' , 'John Doe');
$query->where('name = ?', 'John Doe');
$query->where('name', 'John Doe');
$query->where('name = ?', ['John Doe']);

Parameters

See Also:

• ORM\QueryBuilder\ParenthesisInterface::andWhere()

ORM\QueryBuilder\QueryBuilderInterface::where

↑ top

ORM\QueryBuilder\QueryBuilderInterface::whereIn

public function whereIn(string|array $column, array $values): $this

Add a where in condition with AND.

If $column is an array a composite where in statement will be created

Example: whereIn(['a', 'b'], [[42, 23], [42, 23]]) gets (a,b) IN ((42,23), (23,42)) in mysql

If $values is empty the expression will be 1 = 0 because an empty parenthesis causes an error in SQL.

Parameters

ORM\QueryBuilder\QueryBuilderInterface::whereIn

↑ top

ORM\QueryBuilder\QueryBuilderInterface::whereNotIn

public function whereNotIn(string|array $column, array $values): $this

Add a where not in condition with AND.

If $column is an array a composite where in statement will be created

Example: whereIn(['a', 'b'], [[42, 23], [42, 23]]) gets (a,b) NOT IN ((42,23), (23,42)) in mysql

If $values is empty the expression will be 1 = 1 because an empty parenthesis causes an error in SQL.

Parameters

ORM\QueryBuilder\QueryBuilderInterface::whereNotIn

↑ top