Fuman
\

\Fuman_Db_RecordSetMeta

Hold meta data about a record set

Summary

Methods
Properties
Constants
__construct()
getColumnList()
addOrder()
getOrderString()
getOrder()
hasOrder()
hasOrderColumn()
setIgnoreSQLColumns()
getIgnoreSQLColumns()
getMainOrderColumn()
getMainOrderDirection()
resetOrder()
setLimit()
paginateLimit()
resetLimit()
getLimitCount()
getLimitOffset()
setWhere()
getWhere()
addJoin()
getJoins()
getWhereStatement()
resetWhere()
__clone()
reset()
No public properties found
No constants found
No protected methods found
$_columnList
$_joins
$_order
$_limitCount
$_limitOffset
$_where
$_ignoreSQLColumns
N/A
No private methods found
No private properties found
N/A

Properties

$_order

$_order : array

ORDER BY

Type

array

$_limitCount

$_limitCount : integer

LIMIT count

Type

integer

$_limitOffset

$_limitOffset : integer

LIMIT index

Type

integer

$_ignoreSQLColumns

$_ignoreSQLColumns : boolean

Type

boolean

Methods

addOrder()

addOrder(string  $column, string|null  $direction = null, boolean  $isColumnName = true) : \Fuman_Db_RecordSetMeta

Set sort order

Parameters

string $column
string|null $direction
boolean $isColumnName

Returns

\Fuman_Db_RecordSetMeta

getOrderString()

getOrderString(\Fuman_Db_Abstract  $db) : string

Gets the "ORDER BY .

.." SQL string

Parameters

\Fuman_Db_Abstract $db

Returns

string

getOrder()

getOrder() : array

Returns the orders array

Returns

array

hasOrder()

hasOrder() : boolean

Does record set meta includes order info

Returns

boolean

hasOrderColumn()

hasOrderColumn(string  $columnName) : boolean

returns true, if it has a order columns called $columnName

Parameters

string $columnName

Returns

boolean

setIgnoreSQLColumns()

setIgnoreSQLColumns(boolean  $flag)

Sets if dynamic sql columns should be ignored on sql query creation => improves query performance

Parameters

boolean $flag

getIgnoreSQLColumns()

getIgnoreSQLColumns()

Get ignore sql columns flag

getMainOrderColumn()

getMainOrderColumn() : null|string

Gets main order column

Returns

null|string

getMainOrderDirection()

getMainOrderDirection() : null|string

Gets main order direction (ASC|DESC)

Returns

null|string

setLimit()

setLimit(integer  $count, integer  $offset) : \Fuman_Db_RecordSetMeta

Sets limit

Parameters

integer $count
integer $offset

Returns

\Fuman_Db_RecordSetMeta

paginateLimit()

paginateLimit(integer  $page, integer  $count) : void

Indifference to the setLimit function, the paginateLimit does not require valid int values and decrements the page value with one. Shortcut for paging related issues, where the first page is one.

Parameters

integer $page

!Important: Starts at 1
integer $count

resetLimit()

resetLimit() : void

Resets limit

getLimitCount()

getLimitCount() : integer

Gets the limit count

Returns

integer

getLimitOffset()

getLimitOffset() : integer

Gets the limit offset

Returns

integer

setWhere()

setWhere(\Fuman_Db_Where  $where) : void

Sets where Set {@link Fuman_Db_Where}

Parameters

\Fuman_Db_Where $where

getWhere()

getWhere() : \Fuman_Db_Where

Return {@link Fuman_Db_Where}

Returns

\Fuman_Db_Where

getJoins()

getJoins() : array<mixed,\Fuman_Db_Query_Join>

Returns

array<mixed,\Fuman_Db_Query_Join>

getWhereStatement()

getWhereStatement(\Fuman_Table  $table, \Fuman_Db_Parameters  $parameters) : string

Gets where sql statement (without WHERE)

Parameters

\Fuman_Table $table
\Fuman_Db_Parameters $parameters

Returns

string

resetWhere()

resetWhere() : void

Reset {@link Fuman_Db_Where}