SQL

Properties

type

protected QueryType $type = 'QueryType'

selectGroups

protected array $selectGroups

quoteSpecial

protected string $quoteSpecial = '"'

reservedWords

protected array $reservedWords

select

The list of columns to select in the query.

protected mixed $select

This array holds the column names or expressions that will be included in the SELECT clause of the generated SQL statement.

fields

The fields to update or insert.

protected mixed $fields

This can be a bunch of things, like an array, strings, Table or even a Model or stdClass.

primaryTable

protected array $primaryTable

tables

protected array $tables

where

protected array $where

group

protected array $group

having

protected array $having

window

protected array $window

joins

protected array $joins

combine

protected array $combine

unions

protected array $unions

order

protected array $order

fetch

protected array $fetch

returning

protected mixed $returning

cascade

protected bool $cascade

distinct

public bool $distinct

limit

public int $limit

offset

public int $offset

conflictTarget

public null $conflictTarget

conflictUpdate

public null $conflictUpdate

schemaName

public string $schemaName

valueIndex

private array $valueIndex

Methods

__construct

public __construct(?string $schemaName): void

Parameters

Parameter	Type	Description
$schemaName	string

__toString

public __toString(): string

setReservedWords

public setReservedWords(array $words): void

Parameters

Parameter	Type	Description
$words	array

getSchemaName

public getSchemaName(): ?string

parseSchemaName

public parseSchemaName(string $tableName): void

Parameters

Parameter	Type	Description
$tableName	string

schemaName

public schemaName(string $tableName): string

Parameters

Parameter	Type	Description
$tableName	string

quote

public quote(string $string, bool $addSlashes = true): string

Parameters

Parameter	Type	Description
$string	string
$addSlashes	bool

quoteSpecial

public quoteSpecial(mixed $value): mixed

Parameters

Parameter	Type	Description
$value	mixed

reset

public reset(): self

create

public create(string $name, string $type, bool $ifNotExists): string

Parameters

Parameter	Type	Description
$name	string
$type	string
$ifNotExists	bool

insert

public insert(mixed $fields): self

Parameters

Parameter	Type	Description
$fields	mixed

update

public update(array $fields): self

Parameters

Parameter	Type	Description
$fields	array

delete

public delete(): self

truncate

public truncate(bool $cascade): self

Parameters

Parameter	Type	Description
$cascade	bool

count

public count(): string

exists

public exists(string $tableName, mixed $criteria): string

Parameters

Parameter	Type	Description
$tableName	string
$criteria	mixed

select

public select(mixed $columns): self

Parameters

Parameter	Type	Description
$columns	mixed

distinct

Selects only distinct rows that match based on the specified expressions.

public distinct(string $columns): self

Parameters

Parameter	Type	Description
$columns	string

from

public from(string $table, ?string $alias): self

Parameters

Parameter	Type	Description
$table	string
$alias	string

table

Sets the primary table to use for INSERT, UPDATE or DELETE.

public table(string $table, ?string $alias): self

Parameters

Parameter	Type	Description
$table	string	The name of the table
$alias	string	An optional alias for the table

where

Defines a WHERE selection criteria.

public where(string $criteria): self

Parameters

Parameter	Type	Description
$criteria	string

group

public group(string $columns): self

Parameters

Parameter	Type	Description
$columns	string

having

public having(array $columns): self

Parameters

Parameter	Type	Description
$columns	array

window

public window(string $name, string $partitionBy, null $orderBy): self

Parameters

Parameter	Type	Description
$name	string
$partitionBy	string
$orderBy	null

join

public join(string $references, null $on, ?string $alias, string $type = 'INNER'): self

Parameters

Parameter	Type	Description
$references	string
$on	null
$alias	string
$type	string

union

public union(QueryBuilder $query): self

Parameters

Parameter	Type	Description
$query	QueryBuilder

unionAll

public unionAll(QueryBuilder $query): QueryBuilder

Parameters

Parameter	Type	Description
$query	QueryBuilder

intersect

public intersect(QueryBuilder $query): self

Parameters

Parameter	Type	Description
$query	QueryBuilder

except

public except(QueryBuilder $query): self

Parameters

Parameter	Type	Description
$query	QueryBuilder

order

public order(string $fieldDef, int $sortDirection = 'SORT_ASC'): self

Parameters

Parameter	Type	Description
$fieldDef	string
$sortDirection	int

limit

public limit(?int $limit): self

Parameters

Parameter	Type	Description
$limit	int

offset

public offset(?int $offset): self

Parameters

Parameter	Type	Description
$offset	int

toString

Return the current selection as a valid SQL string.

public toString(bool $terminateWithColon): string

Parameters

Parameter	Type	Description
$terminateWithColon	bool

field

public field(string $string): string

Parameters

Parameter	Type	Description
$string	string

prepareFields

public prepareFields(mixed $fields, array $exclude, array $tables): string

Parameters

Parameter	Type	Description
$fields	mixed
$exclude	array
$tables	array

prepareValue

public prepareValue(string $key, mixed $value): mixed

Parameters

Parameter	Type	Description
$key	string
$value	mixed

prepareArrayAliases

public prepareArrayAliases(array $array): void

Parameters

Parameter	Type	Description
$array	array

prepareCriteria

public prepareCriteria(string $criteria, string $bindType = 'AND', string $tissue = '=', ?string $parentRef, bool $setKey = true, int $depth): string

Parameters

Parameter	Type	Description
$criteria	string
$bindType	string
$tissue	string
$parentRef	string
$setKey	bool
$depth	int

getCriteriaValues

Retrieves the criteria values by combining the provided parameter values with the default values.

public getCriteriaValues(): void

Iterates over the internal value index and, for each key and its associated values, constructs a criteria value array. If a value for the key exists in the provided $paramValues array, it is used; otherwise, the default value is used.

prepareCriteriaValues

Prepares criteria values for use in SQL queries by mapping parameter values to indexed keys.

public prepareCriteriaValues(array $paramValues): void

Parameters

Parameter	Type	Description
$paramValues	array

returning

public returning(mixed $columns): self

Parameters

Parameter	Type	Description
$columns	mixed

onConflict

public onConflict(null $target, null $update): self

Parameters

Parameter	Type	Description
$target	null
$update	null

prepareValueAction

private prepareValueAction(string $action, mixed $value): mixed

Parameters

Parameter	Type	Description
$action	string
$value	mixed

prepareCriteriaAction

private prepareCriteriaAction(string $action, mixed $value, string $key, ?string $tissue = '=', bool $setKey = true, int $depth, null $): void

Parameters

Parameter	Type	Description
$action	string
$value	mixed
$key	string
$tissue	string
$setKey	bool
$depth	int
$	null

tables

private tables(): void

prepareOrder

private prepareOrder(string $orderDefinition): string

Parameters

Parameter	Type	Description
$orderDefinition	string

toSELECTString

private toSELECTString(): string

toINSERTString

private toINSERTString(): string

toUPDATEString

private toUPDATEString(): string

toDELETEString

private toDELETEString(): string

toTRUNCATEString

private toTRUNCATEString(): string

---

Generated by Hazaar API Doc Generator on Sun, 01 Mar 2026 09:22:25 +0000