Nextcloud Circles API

ExtendedQueryBuilder extends QueryBuilder
in package
Uses TArrayTools

Table of Contents

$TYPE_ARRAY  : mixed
$TYPE_BOOLEAN  : mixed
$TYPE_INTEGER  : mixed
$TYPE_NULL  : mixed
$TYPE_SERIALIZABLE  : mixed
$TYPE_STRING  : mixed
$defaultSelectAlias  : string
$defaultValues  : array<string|int, mixed>
__construct()  : mixed
addDefaultValue()  : $this
asItem()  : IQueryRow
asItemFromField()  : IQueryRow
asItems()  : array<string|int, IQueryRow>
asItemsFromField()  : array<string|int, IQueryRow>
chunk()  : void
exprFilter()  : string
exprFilterArray()  : ICompositeExpression
exprFilterBitwise()  : string
exprFilterBool()  : string
exprFilterEmpty()  : ICompositeExpression
exprFilterInArray()  : string
exprFilterInt()  : string
exprFilterNull()  : ICompositeExpression
exprGt()  : string
exprLike()  : string
exprLimit()  : string
exprLimitArray()  : ICompositeExpression
exprLimitBitwise()  : string
exprLimitBool()  : string
exprLimitEmpty()  : ICompositeExpression
exprLimitInArray()  : string
exprLimitInt()  : string
exprLimitNull()  : ICompositeExpression
exprLt()  : string
exprUnlike()  : string
filter()  : void
filterArray()  : void
filterBitwise()  : void
filterBool()  : void
filterEmpty()  : void
filterInArray()  : void
filterInt()  : void
filterNull()  : void
generateSelect()  : $this
generateSelectAlias()  : $this
getDefaultSelectAlias()  : string
getDefaultValues()  : array<string|int, mixed>
getRow()  : IQueryRow
getRows()  : array<string|int, IQueryRow>
gt()  : void
like()  : void
limit()  : void
limitArray()  : void
limitBitwise()  : void
limitBool()  : void
limitEmpty()  : void
limitInArray()  : void
limitInt()  : void
limitNull()  : void
limitToCreation()  : self
Limit the request to the creation
limitToDBFieldDateTime()  : void
limitToId()  : void
Limit the request to the Id
limitToIds()  : void
limitToIdString()  : void
limitToMemberId()  : void
limitToSince()  : void
limitToStatus()  : void
limitToToken()  : void
limitToType()  : void
limitToTypeString()  : void
limitToUniqueId()  : void
limitToUserId()  : void
lt()  : void
paginate()  : void
searchInDBField()  : void
setDefaultSelectAlias()  : self
typeOf()  : string
unlike()  : void
validKey()  : bool
cleanArray()  : mixed
extractArray()  : mixed
get()  : string
getArray()  : array<string|int, mixed>
getBool()  : bool
getFloat()  : float
getInt()  : int
getList()  : array<string|int, mixed>
getObj()  : mixed
mustContains()  : mixed
parseSimpleSelectSql()  : IQueryRow

Properties

$TYPE_ARRAY

public static mixed $TYPE_ARRAY = 'Array'

$TYPE_BOOLEAN

public static mixed $TYPE_BOOLEAN = 'Boolean'

$TYPE_INTEGER

public static mixed $TYPE_INTEGER = 'Integer'

$TYPE_SERIALIZABLE

public static mixed $TYPE_SERIALIZABLE = 'Serializable'

$TYPE_STRING

public static mixed $TYPE_STRING = 'String'

Methods

addDefaultValue()

public addDefaultValue(string $key, string $value) : $this
Parameters
$key : string
$value : string
Return values
$this —

asItems()

public asItems(string $object[, array<string|int, mixed> $params = [] ]) : array<string|int, IQueryRow>
Parameters
$object : string
$params : array<string|int, mixed> = []
Return values
array<string|int, IQueryRow> —

asItemsFromField()

public asItemsFromField(string $field[, array<string|int, mixed> $params = [] ]) : array<string|int, IQueryRow>
Parameters
$field : string
$params : array<string|int, mixed> = []
Return values
array<string|int, IQueryRow> —

chunk()

public chunk(int $offset, int $limit) : void
Parameters
$offset : int
$limit : int
Return values
void —

exprFilter()

public exprFilter(string $field, string $value[, string $alias = '' ][, bool $cs = true ]) : string
Parameters
$field : string
$value : string
$alias : string = ''
$cs : bool = true
Return values
string —

exprFilterArray()

public exprFilterArray(string $field, array<string|int, mixed> $values[, string $alias = '' ][, bool $cs = true ]) : ICompositeExpression
Parameters
$field : string
$values : array<string|int, mixed>
$alias : string = ''
$cs : bool = true
Return values
ICompositeExpression —

exprFilterBitwise()

public exprFilterBitwise(string $field, int $flag[, string $alias = '' ]) : string
Parameters
$field : string
$flag : int
$alias : string = ''
Return values
string —

exprFilterBool()

public exprFilterBool(string $field, bool $value[, string $alias = '' ]) : string
Parameters
$field : string
$value : bool
$alias : string = ''
Return values
string —

exprFilterEmpty()

public exprFilterEmpty(string $field[, bool $norNull = false ][, string $alias = '' ]) : ICompositeExpression
Parameters
$field : string
$norNull : bool = false
$alias : string = ''
Return values
ICompositeExpression —

exprFilterInArray()

public exprFilterInArray(string $field, array<string|int, mixed> $values[, string $alias = '' ]) : string
Parameters
$field : string
$values : array<string|int, mixed>
$alias : string = ''
Return values
string —

exprFilterInt()

public exprFilterInt(string $field, int $value[, string $alias = '' ]) : string
Parameters
$field : string
$value : int
$alias : string = ''
Return values
string —

exprFilterNull()

public exprFilterNull(string $field[, bool $norEmpty = false ][, string $alias = '' ]) : ICompositeExpression
Parameters
$field : string
$norEmpty : bool = false
$alias : string = ''
Return values
ICompositeExpression —

exprGt()

public exprGt(string $field, int $value[, bool $gte = false ][, string $alias = '' ]) : string
Parameters
$field : string
$value : int
$gte : bool = false
$alias : string = ''
Return values
string —

exprLike()

public exprLike(string $field, string $value[, string $alias = '' ][, bool $cs = true ]) : string
Parameters
$field : string
$value : string
$alias : string = ''
$cs : bool = true
Return values
string —

exprLimit()

public exprLimit(string $field, string $value[, string $alias = '' ][, bool $cs = true ]) : string
Parameters
$field : string
$value : string
$alias : string = ''
$cs : bool = true
Return values
string —

exprLimitArray()

public exprLimitArray(string $field, array<string|int, mixed> $values[, string $alias = '' ][, bool $cs = true ]) : ICompositeExpression
Parameters
$field : string
$values : array<string|int, mixed>
$alias : string = ''
$cs : bool = true
Return values
ICompositeExpression —

exprLimitBitwise()

public exprLimitBitwise(string $field, int $flag[, string $alias = '' ]) : string
Parameters
$field : string
$flag : int
$alias : string = ''
Return values
string —

exprLimitBool()

public exprLimitBool(string $field, bool $value[, string $alias = '' ]) : string
Parameters
$field : string
$value : bool
$alias : string = ''
Return values
string —

exprLimitEmpty()

public exprLimitEmpty(string $field[, bool $orNull = false ][, string $alias = '' ]) : ICompositeExpression
Parameters
$field : string
$orNull : bool = false
$alias : string = ''
Return values
ICompositeExpression —

exprLimitInArray()

public exprLimitInArray(string $field, array<string|int, mixed> $values[, string $alias = '' ]) : string
Parameters
$field : string
$values : array<string|int, mixed>
$alias : string = ''
Return values
string —

exprLimitInt()

public exprLimitInt(string $field, int $value[, string $alias = '' ]) : string
Parameters
$field : string
$value : int
$alias : string = ''
Return values
string —

exprLimitNull()

public exprLimitNull(string $field[, bool $orEmpty = false ][, string $alias = '' ]) : ICompositeExpression
Parameters
$field : string
$orEmpty : bool = false
$alias : string = ''
Return values
ICompositeExpression —

exprLt()

public exprLt(string $field, int $value[, bool $lte = false ][, string $alias = '' ]) : string
Parameters
$field : string
$value : int
$lte : bool = false
$alias : string = ''
Return values
string —

exprUnlike()

public exprUnlike(string $field, string $value[, string $alias = '' ][, bool $cs = true ]) : string
Parameters
$field : string
$value : string
$alias : string = ''
$cs : bool = true
Return values
string —

filter()

public filter(string $field, string $value[, string $alias = '' ][, bool $cs = true ]) : void
Parameters
$field : string
$value : string
$alias : string = ''
$cs : bool = true
Return values
void —

filterArray()

public filterArray(string $field, array<string|int, mixed> $value[, string $alias = '' ][, bool $cs = true ]) : void
Parameters
$field : string
$value : array<string|int, mixed>
$alias : string = ''
$cs : bool = true
Return values
void —

filterBitwise()

public filterBitwise(string $field, int $flag[, string $alias = '' ]) : void
Parameters
$field : string
$flag : int
$alias : string = ''
Return values
void —

filterBool()

public filterBool(string $field, bool $value[, string $alias = '' ]) : void
Parameters
$field : string
$value : bool
$alias : string = ''
Return values
void —

filterEmpty()

public filterEmpty(string $field[, bool $norNull = false ][, string $alias = '' ]) : void
Parameters
$field : string
$norNull : bool = false
$alias : string = ''
Return values
void —

filterInArray()

public filterInArray(string $field, array<string|int, mixed> $value[, string $alias = '' ]) : void
Parameters
$field : string
$value : array<string|int, mixed>
$alias : string = ''
Return values
void —

filterInt()

public filterInt(string $field, int $value[, string $alias = '' ]) : void
Parameters
$field : string
$value : int
$alias : string = ''
Return values
void —

filterNull()

public filterNull(string $field[, bool $norEmpty = false ][, string $alias = '' ]) : void
Parameters
$field : string
$norEmpty : bool = false
$alias : string = ''
Return values
void —

generateSelect()

public generateSelect(string $table, array<string|int, mixed> $fields[, string $alias = '' ]) : $this
Parameters
$table : string
$fields : array<string|int, mixed>
$alias : string = ''
Return values
$this —

generateSelectAlias()

public generateSelectAlias(array<string|int, mixed> $fields, string $alias, string $prefix[, array<string|int, mixed> $default = [] ]) : $this
Parameters
$fields : array<string|int, mixed>
$alias : string
$prefix : string
$default : array<string|int, mixed> = []
Return values
$this —

getDefaultSelectAlias()

public getDefaultSelectAlias() : string
Return values
string —

getDefaultValues()

public getDefaultValues() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getRows()

public getRows(callable $method[, string $object = '' ][, array<string|int, mixed> $params = [] ]) : array<string|int, IQueryRow>
Parameters
$method : callable
$object : string = ''
$params : array<string|int, mixed> = []
Return values
array<string|int, IQueryRow> —

gt()

public gt(string $field, int $value[, bool $gte = false ][, string $alias = '' ]) : void
Parameters
$field : string
$value : int
$gte : bool = false
$alias : string = ''
Return values
void —

like()

public like(string $field, string $value[, string $alias = '' ][, bool $cs = true ]) : void
Parameters
$field : string
$value : string
$alias : string = ''
$cs : bool = true
Return values
void —

limit()

public limit(string $field, string $value[, string $alias = '' ][, bool $cs = true ]) : void
Parameters
$field : string
$value : string
$alias : string = ''
$cs : bool = true
Return values
void —

limitArray()

public limitArray(string $field, array<string|int, mixed> $value[, string $alias = '' ][, bool $cs = true ]) : void
Parameters
$field : string
$value : array<string|int, mixed>
$alias : string = ''
$cs : bool = true
Return values
void —

limitBitwise()

public limitBitwise(string $field, int $flag[, string $alias = '' ]) : void
Parameters
$field : string
$flag : int
$alias : string = ''
Return values
void —

limitBool()

public limitBool(string $field, bool $value[, string $alias = '' ]) : void
Parameters
$field : string
$value : bool
$alias : string = ''
Return values
void —

limitEmpty()

public limitEmpty(string $field[, bool $orNull = false ][, string $alias = '' ]) : void
Parameters
$field : string
$orNull : bool = false
$alias : string = ''
Return values
void —

limitInArray()

public limitInArray(string $field, array<string|int, mixed> $value[, string $alias = '' ]) : void
Parameters
$field : string
$value : array<string|int, mixed>
$alias : string = ''
Return values
void —

limitInt()

public limitInt(string $field, int $value[, string $alias = '' ]) : void
Parameters
$field : string
$value : int
$alias : string = ''
Return values
void —

limitNull()

public limitNull(string $field[, bool $orEmpty = false ][, string $alias = '' ]) : void
Parameters
$field : string
$orEmpty : bool = false
$alias : string = ''
Return values
void —

limitToCreation()

Limit the request to the creation

public limitToCreation(int $delay) : self
Parameters
$delay : int
Tags
throws
Exception
Return values
self —

limitToDBFieldDateTime()

public limitToDBFieldDateTime(string $field, DateTime $date[, bool $orNull = false ]) : void
Parameters
$field : string
$date : DateTime
$orNull : bool = false
Return values
void —

limitToId()

Limit the request to the Id

public limitToId(int $id) : void
Parameters
$id : int
Return values
void —

limitToIds()

public limitToIds(array<string|int, mixed> $ids) : void
Parameters
$ids : array<string|int, mixed>
Return values
void —

limitToIdString()

public limitToIdString(string $id) : void
Parameters
$id : string
Return values
void —

limitToMemberId()

public limitToMemberId(string $memberId) : void
Parameters
$memberId : string
Return values
void —

limitToStatus()

public limitToStatus(string $status) : void
Parameters
$status : string
Return values
void —

limitToToken()

public limitToToken(string $token) : void
Parameters
$token : string
Return values
void —

limitToType()

public limitToType(int $type) : void
Parameters
$type : int
Return values
void —

limitToTypeString()

public limitToTypeString(string $type) : void
Parameters
$type : string
Return values
void —

limitToUniqueId()

public limitToUniqueId(string $uniqueId) : void
Parameters
$uniqueId : string
Return values
void —

limitToUserId()

public limitToUserId(string $userId) : void
Parameters
$userId : string
Return values
void —

lt()

public lt(string $field, int $value[, bool $lte = false ][, string $alias = '' ]) : void
Parameters
$field : string
$value : int
$lte : bool = false
$alias : string = ''
Return values
void —

paginate()

public paginate(int $size, int $page) : void
Parameters
$size : int
$page : int
Return values
void —

searchInDBField()

public searchInDBField(string $field, string $value) : void
Parameters
$field : string
$value : string
Return values
void —

setDefaultSelectAlias()

public setDefaultSelectAlias(string $alias) : self
Parameters
$alias : string
Return values
self —

typeOf()

public typeOf(string $key, array<string|int, mixed> $arr[, bool $root = true ]) : string
Parameters
$key : string
$arr : array<string|int, mixed>
$root : bool = true
Tags
throws
ItemNotFoundException
throws
UnknownTypeException
Return values
string —

unlike()

public unlike(string $field, string $value[, string $alias = '' ][, bool $cs = true ]) : void
Parameters
$field : string
$value : string
$alias : string = ''
$cs : bool = true
Return values
void —

validKey()

public validKey(string $k, array<string|int, mixed> $arr) : bool
Parameters
$k : string
$arr : array<string|int, mixed>
Return values
bool —

cleanArray()

protected cleanArray(array<string|int, mixed> &$arr) : mixed
Parameters
$arr : array<string|int, mixed>
Return values
mixed —

extractArray()

protected extractArray(string $k, string $value, array<string|int, mixed> $list) : mixed
Parameters
$k : string
$value : string
$list : array<string|int, mixed>
Tags
throws
ArrayNotFoundException
Return values
mixed —

get()

protected get(string $k, array<string|int, mixed> $arr[, string $default = '' ]) : string
Parameters
$k : string
$arr : array<string|int, mixed>
$default : string = ''
Return values
string —

getArray()

protected getArray(string $k, array<string|int, mixed> $arr[, array<string|int, mixed> $default = [] ]) : array<string|int, mixed>
Parameters
$k : string
$arr : array<string|int, mixed>
$default : array<string|int, mixed> = []
Return values
array<string|int, mixed> —

getBool()

protected getBool(string $k, array<string|int, mixed> $arr[, bool $default = false ]) : bool
Parameters
$k : string
$arr : array<string|int, mixed>
$default : bool = false
Return values
bool —

getFloat()

protected getFloat(string $k, array<string|int, mixed> $arr, float $default) : float
Parameters
$k : string
$arr : array<string|int, mixed>
$default : float
Return values
float —

getInt()

protected getInt(string $k, array<string|int, mixed> $arr, int $default) : int
Parameters
$k : string
$arr : array<string|int, mixed>
$default : int
Return values
int —

getList()

protected getList(string $k, array<string|int, mixed> $arr, array<string|int, mixed> $import[, array<string|int, mixed> $default = [] ]) : array<string|int, mixed>
Parameters
$k : string
$arr : array<string|int, mixed>
$import : array<string|int, mixed>
$default : array<string|int, mixed> = []
Return values
array<string|int, mixed> —

getObj()

protected getObj(string $k, array<string|int, mixed> $arr[, JsonSerializable|null $default = null ]) : mixed
Parameters
$k : string
$arr : array<string|int, mixed>
$default : JsonSerializable|null = null
Return values
mixed —

mustContains()

protected mustContains(array<string|int, mixed> $keys, array<string|int, mixed> $arr) : mixed
Parameters
$keys : array<string|int, mixed>
$arr : array<string|int, mixed>
Tags
throws
MalformedArrayException
Return values
mixed —

Search results