Table

Properties

adapter

private Adapter $adapter

queryBuilder

private QueryBuilder $queryBuilder

table

private string $table

result

public Result $result

Methods

__construct

public __construct(Adapter $adapter, string $table, ?string $alias): void

Parameters

Parameter	Type	Description
$adapter	Adapter
$table	string
$alias	string

__toString

public __toString(): string

toString

public toString(): string

exists

public exists(mixed $criteria): bool

Parameters

Parameter	Type	Description
$criteria	mixed

select

public select(string $columns = '*'): self

Parameters

Parameter	Type	Description
$columns	string

distinct

public distinct(string $columns): self

Parameters

Parameter	Type	Description
$columns	string

limit

public limit(int $limit): self

Parameters

Parameter	Type	Description
$limit	int

offset

public offset(int $offset): self

Parameters

Parameter	Type	Description
$offset	int

order

public order(string $columns, int $direction = 'SORT_ASC'): self

Parameters

Parameter	Type	Description
$columns	string
$direction	int

group

public group(string $columns): self

Parameters

Parameter	Type	Description
$columns	string

having

public having(string $having): self

Parameters

Parameter	Type	Description
$having	string

join

Join a table to the current query using the provided join criteria.

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

Parameters

Parameter	Type	Description
$table	string
$on	string	The join criteria. This is mostly just a standard query selection criteria.
$alias	string	an alias to use for the joined table
$type	string	the join type such as INNER, OUTER, LEFT, RIGHT, etc

leftJoin

Join a table to the current query using the provided join criteria.

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

Parameters

Parameter	Type	Description
$table	string
$on	string	The join criteria. This is mostly just a standard query selection criteria.
$alias	string	an alias to use for the joined table

rightJoin

Join a table to the current query using the provided join criteria.

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

Parameters

Parameter	Type	Description
$table	string
$on	string	The join criteria. This is mostly just a standard query selection criteria.
$alias	string	an alias to use for the joined table

innerJoin

Join a table to the current query using the provided join criteria.

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

Parameters

Parameter	Type	Description
$table	string
$on	string	The join criteria. This is mostly just a standard query selection criteria.
$alias	string	an alias to use for the joined table

outerJoin

Join a table to the current query using the provided join criteria.

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

Parameters

Parameter	Type	Description
$table	string
$on	string	The join criteria. This is mostly just a standard query selection criteria.
$alias	string	an alias to use for the joined table

fullJoin

Join a table to the current query using the provided join criteria.

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

Parameters

Parameter	Type	Description
$table	string
$on	string	The join criteria. This is mostly just a standard query selection criteria.
$alias	string	an alias to use for the joined table

crossJoin

Join a table to the current query using the provided join criteria.

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

Parameters

Parameter	Type	Description
$table	string
$on	string	The join criteria. This is mostly just a standard query selection criteria.
$alias	string	an alias to use for the joined table

insert

public insert(mixed $values, string $returning, string $conflictTarget, mixed $conflictUpdate, ?Table $table): mixed

Parameters

Parameter	Type	Description
$values	mixed
$returning	string
$conflictTarget	string
$conflictUpdate	mixed
$table	Table

insertModel

public insertModel(Model $model, string $conflictTarget, mixed $conflictUpdate): Model

Parameters

Parameter	Type	Description
$model	Model
$conflictTarget	string
$conflictUpdate	mixed

update

public update(mixed $values, string $where = [], mixed $returning): mixed

Parameters

Parameter	Type	Description
$values	mixed
$where	string
$returning	mixed

updateModel

Updates the given model in the database based on the specified criteria.

public updateModel(Model $model, string $where = []): Model

Parameters

Parameter	Type	Description
$model	Model	the model instance to be updated
$where	string	The criteria for selecting the record(s) to be updated. Can be an array of keys or a single key.

delete

public delete(string $where): int

Parameters

Parameter	Type	Description
$where	string

deleteAll

public deleteAll(): int

truncate

public truncate(bool $cascade = false): bool

Parameters

Parameter	Type	Description
$cascade	bool

find

public find(mixed $where, string $columns): self

Parameters

Parameter	Type	Description
$where	mixed
$columns	string

where

public where(mixed $where): self

Parameters

Parameter	Type	Description
$where	mixed

findOne

public findOne(string $where, string $columns, false $): void

Parameters

Parameter	Type	Description
$where	string
$columns	string
$	false

findOneModel

Finds a single model instance based on the specified conditions.

public findOneModel(string $model, string $where): Model

Parameters

Parameter	Type	Description
$model	string	the fully qualified class name of the model to instantiate
$where	string	the conditions to use for finding the record

findOneRow

public findOneRow(string $where, string $columns): Row

Parameters

Parameter	Type	Description
$where	string
$columns	string

fetch

public fetch(false $): void

Parameters

Parameter	Type	Description
$	false

fetchAll

public fetchAll(?string $keyColumn, false $): void

Parameters

Parameter	Type	Description
$keyColumn	string
$	false

fetchAllColumn

public fetchAllColumn(string $columnName, mixed $fetchArgument, bool $clobberDupNamedCols = false): void

Parameters

Parameter	Type	Description
$columnName	string
$fetchArgument	mixed
$clobberDupNamedCols	bool

fetchModel

Fetches a model instance of the specified class.

public fetchModel(string $modelClass): Model

Parameters

Parameter	Type	Description
$modelClass	string	the fully qualified class name of the model to fetch

fetchAllModel

Fetches a collection of model instances of the specified class.

public fetchAllModel(string $modelClass, ?string $keyColumn): void

Parameters

Parameter	Type	Description
$modelClass	string	the fully qualified class name of the model to fetch
$keyColumn	string

toArray

public toArray(): void

row

public row(): Row

count

public count(): int

describe

public describe(false $): void

Parameters

Parameter	Type	Description
$	false

result

public result(): Result

errorInfo

public errorInfo(): void

reset

public reset(): bool

execute

public execute(): int

create

public create(mixed $columns): bool

Parameters

Parameter	Type	Description
$columns	mixed

drop

public drop(): bool

getPrimaryKey

public getPrimaryKey(false $): void

Parameters

Parameter	Type	Description
$	false

---

Generated by Hazaar API Doc Generator