Documentation

CustomExpression extends SelectQuery
in package
uses log

Table of Contents

Properties

$idFormatter  : callable
$colIndexes  : array<string|int, int>
$columns  : array<string|int, mixed>
$dbc  : mysqli
$joins  : array<string|int, mixed>
$orderColumns  : array<string|int, mixed>
$table  : string
$where  : array<string|int, mixed>

Methods

__construct()  : mixed
addJoin()  : mixed
add join and update comlumn indexes
addOrder()  : mixed
addWhere()  : mixed
dangerouslyFetchAsArray()  : array<string|int, mixed>
dangerouslyGetResult()  : object
excludeJoins()  : mixed
execute()  : IResultSet|bool
formatId()  : mixed
getColIndex()  : mixed
getDBC()  : mixed
getQueryInstance()  : mixed
joinExists()  : bool
sqlOrderBy()  : string
sqlWhere()  : mixed
sqlColumns()  : string
sqlDeleteQuery()  : string
sqlInsertQuery()  : string
sqlJoins()  : string
sqlSelectQuery()  : string
sqlUpdateQuery()  : string

Properties

$idFormatter

public callable $idFormatter

really useful? to be documented

$colIndexes

protected array<string|int, int> $colIndexes = []

An array containing the positional index of every column

$columns

protected array<string|int, mixed> $columns

$orderColumns

protected array<string|int, mixed> $orderColumns

Methods

__construct()

public __construct(mysqli $dbc, string $table, array<string|int, mixed> $columns, array<string|int, mixed> $joins, array<string|int, mixed> $where, array<string|int, mixed> $orderColumns) : mixed
Parameters
$dbc : mysqli

The Database connection

$table : string

The main Table for the select query

$columns : array<string|int, mixed>

The columns in the form table => [col1, col2, ...]

$joins : array<string|int, mixed>

The joins in the form ['name' => ['type', 'table', 'condition', [col1, col2, ...]], ...]

$where : array<string|int, mixed>

The where clauses joined together by AND

$orderColumns : array<string|int, mixed>

The columns to sort

addJoin()

add join and update comlumn indexes

public addJoin(string $joinName, array<string|int, mixed> $joinDefinition) : mixed
Parameters
$joinName : string
$joinDefinition : array<string|int, mixed>

['type', 'table', 'condition', [ 'col', ... ]]

addOrder()

public addOrder(string $column[, string|null $order = 'ASC' ]) : mixed
Parameters
$column : string
$order : string|null = 'ASC'

addWhere()

public addWhere(string $where) : mixed
Parameters
$where : string

dangerouslyFetchAsArray()

public dangerouslyFetchAsArray(string $query) : array<string|int, mixed>
Parameters
$query : string
Return values
array<string|int, mixed>

dangerouslyGetResult()

public dangerouslyGetResult(string $query) : object
Parameters
$query : string
Return values
object

excludeJoins()

public excludeJoins(array<string|int, mixed> $indexes) : mixed
Parameters
$indexes : array<string|int, mixed>

formatId()

public formatId(mixed $id) : mixed
Parameters
$id : mixed

getColIndex()

public getColIndex(string $columnIdentifier[, string|null $joinName = null ]) : mixed
Parameters
$columnIdentifier : string
$joinName : string|null = null

getQueryInstance()

public getQueryInstance() : mixed

joinExists()

public joinExists(string $join) : bool
Parameters
$join : string
Return values
bool

sqlOrderBy()

public sqlOrderBy(array<string|int, mixed> $orderColumns) : string
Parameters
$orderColumns : array<string|int, mixed>
Return values
string

sqlWhere()

public sqlWhere(array<string|int, mixed> $where) : mixed
Parameters
$where : array<string|int, mixed>

sqlColumns()

protected sqlColumns(array<string|int, mixed> $tableColumns) : string
Parameters
$tableColumns : array<string|int, mixed>

[$table => [ $column, ... ], ...]

Return values
string

sqlDeleteQuery()

protected sqlDeleteQuery(string $table, string $where) : string
Parameters
$table : string
$where : string

condition

Return values
string

sqlInsertQuery()

protected sqlInsertQuery(array<string|int, mixed> $values, string $table) : string
Parameters
$values : array<string|int, mixed>

[$field => $value, ...]

$table : string
Return values
string

sqlJoins()

protected sqlJoins(array<string|int, mixed> $joins) : string
Parameters
$joins : array<string|int, mixed>
Return values
string

sqlSelectQuery()

protected sqlSelectQuery(array<string|int, mixed> $columns, string $table, array<string|int, mixed> $joins, array<string|int, mixed> $where, array<string|int, mixed> $orderColumns) : string
Parameters
$columns : array<string|int, mixed>

[$table => [ $column, ... ], ...]

$table : string
$joins : array<string|int, mixed>

array of sql joins

$where : array<string|int, mixed>

array of where clauses joined with AND

$orderColumns : array<string|int, mixed>

array of order clauses joined with ,

Return values
string

sqlUpdateQuery()

protected sqlUpdateQuery(array<string|int, mixed> $values, string $table, string $where) : string
Parameters
$values : array<string|int, mixed>
$table : string
$where : string

condition

Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results