class Listing extends AbstractListing (View source)

Properties

protected AbstractDao $dao from AbstractModel
protected string|array $order from AbstractListing
protected string|array $orderKey from AbstractListing
protected int $limit from AbstractListing
protected int $offset from AbstractListing
protected string $condition from AbstractListing
protected array $conditionVariables from AbstractListing
protected string $groupBy from AbstractListing
protected array $validOrders from AbstractListing
protected array $conditionParams from AbstractListing
array $tags Contains the results of the list. They are all an instance of Tag

Methods

Dao
getDao()

No description

setDao($dao)

No description

getResource() deprecated

No description

initDao(null $key = null, bool $forceDetection = false)

No description

static string|null
locateDaoClass(string $modelClass)

No description

$this
setValues(array $data = [])

No description

$this
setValue($key, $value)

No description

array
__sleep()

No description

mixed
__call($method, $args)

No description

__clone()

No description

array
getObjectVars()

returns object values without the dao

array
__debugInfo()

No description

void
beginTransaction()

No description

void
commit()

No description

void
rollBack()

No description

void
configure()

No description

array
getValidTableColumns(string $table, bool $cache)

No description

void
resetValidTableColumnsCache(string $table)

No description

bool
isValidOrderKey($key)

Tests if the given key is an valid order key to sort the results

int
getLimit()

No description

int
getOffset()

No description

array|string
getOrder()

No description

$this
setLimit($limit)

No description

$this
setOffset($offset)

No description

$this
setOrder($order)

No description

array|string
getOrderKey()

No description

$this
setOrderKey(string|array $orderKey, bool $quote = true)

No description

$this
addConditionParam($key, null $value = null, string $concatenator = 'AND')

No description

array
getConditionParams()

No description

$this
resetConditionParams()

No description

string
getCondition()

No description

$this
setCondition($condition, null $conditionVariables = null)

No description

string
getGroupBy()

No description

array
getValidOrders()

No description

$this
setGroupBy($groupBy, bool $qoute = true)

No description

$this
setValidOrders($validOrders)

No description

string
quote($value, $type = null)

No description

$this
setConditionVariables($conditionVariables)

No description

array
getConditionVariables()

No description

getQuery()

No description

$this
setTags($tags)

No description

array
getTags()

No description

Details

Dao getDao()

Return Value

Dao

AbstractModel setDao($dao)

Parameters

$dao

Return Value

AbstractModel

AbstractDao getResource() deprecated

deprecated

Return Value

AbstractDao

initDao(null $key = null, bool $forceDetection = false)

Parameters

null $key
bool $forceDetection

Exceptions

Exception

static string|null locateDaoClass(string $modelClass)

Parameters

string $modelClass

Return Value

string|null

$this setValues(array $data = [])

Parameters

array $data

Return Value

$this

$this setValue($key, $value)

Parameters

$key
$value

Return Value

$this

array __sleep()

Return Value

array

mixed __call($method, $args)

Parameters

$method
$args

Return Value

mixed

Exceptions

Exception

__clone()

array getObjectVars()

returns object values without the dao

Return Value

array

array __debugInfo()

Return Value

array

void beginTransaction()

Return Value

void

void commit()

Return Value

void

void rollBack()

Return Value

void

void configure()

Return Value

void

array getValidTableColumns(string $table, bool $cache)

Parameters

string $table
bool $cache

Return Value

array

void resetValidTableColumnsCache(string $table)

Parameters

string $table

Return Value

void

bool isValidOrderKey($key)

Tests if the given key is an valid order key to sort the results

Parameters

$key

Return Value

bool

int getLimit()

Return Value

int

int getOffset()

Return Value

int

array|string getOrder()

Return Value

array|string

$this setLimit($limit)

Parameters

$limit

Return Value

$this

$this setOffset($offset)

Parameters

$offset

Return Value

$this

$this setOrder($order)

Parameters

$order

Return Value

$this

array|string getOrderKey()

Return Value

array|string

$this setOrderKey(string|array $orderKey, bool $quote = true)

Parameters

string|array $orderKey
bool $quote

Return Value

$this

$this addConditionParam($key, null $value = null, string $concatenator = 'AND')

Parameters

$key
null $value
string $concatenator

Return Value

$this

array getConditionParams()

Return Value

array

$this resetConditionParams()

Return Value

$this

string getCondition()

Return Value

string

$this setCondition($condition, null $conditionVariables = null)

Parameters

$condition
null $conditionVariables

Return Value

$this

string getGroupBy()

Return Value

string

array getValidOrders()

Return Value

array

$this setGroupBy($groupBy, bool $qoute = true)

Parameters

$groupBy
bool $qoute

Return Value

$this

$this setValidOrders($validOrders)

Parameters

$validOrders

Return Value

$this

string quote($value, $type = null)

Parameters

$value
$type

Return Value

string

$this setConditionVariables($conditionVariables)

Parameters

$conditionVariables

Return Value

$this

array getConditionVariables()

Return Value

array

QueryBuilder getQuery()

Return Value

QueryBuilder

$this setTags($tags)

Parameters

$tags

Return Value

$this

array getTags()

Return Value

array