AdiantiStandardCollectionTrait
Standard Collection Trait
Tags
Table of Contents
Properties
- $afterLoadCallback : mixed
- $afterSearchCallback : mixed
- $criteria : mixed
- $debugMode : mixed
- $direction : mixed
- $filterFields : mixed
- $filterTransformers : mixed
- $formFilters : mixed
- $limit : mixed
- $loaded : mixed
- $logic_operators : mixed
- $operators : mixed
- $order : mixed
- $orderCommands : mixed
- $transformCallback : mixed
Methods
- onReload() : mixed
- Load the datagrid with the database objects
- onSearch() : mixed
- Register the filter in the session
- show() : mixed
- method show() Shows the page
- addFilterField() : mixed
- method addFilterField() Add a field that will be used for filtering
- clearFilters() : mixed
- clear Filters
- enableTransactionDebug() : mixed
- Enable Debug
- setAfterLoadCallback() : mixed
- Define a callback method to transform objects before load them into datagrid
- setAfterSearchCallback() : mixed
- Define a callback method to transform objects after search action
- setCollectionObject() : mixed
- Set list widget
- setCriteria() : mixed
- method setCriteria() Define the criteria
- setDefaultOrder() : mixed
- Define the default order
- setFilterField() : mixed
- method setFilterField() Define wich field will be used for filtering PS: Just for Backwards compatibility
- setLimit() : mixed
- method setLimit() Define the record limit
- setOperator() : mixed
- method setOperator() Define the filtering operator PS: Just for Backwards compatibility
- setOrderCommand() : mixed
- Set order command
- setTransformer() : mixed
- Define a callback method to transform objects before load them into datagrid
Properties
$afterLoadCallback
protected
mixed
$afterLoadCallback
$afterSearchCallback
protected
mixed
$afterSearchCallback
$criteria
protected
mixed
$criteria
$debugMode
protected
mixed
$debugMode
$direction
protected
mixed
$direction
$filterFields
protected
mixed
$filterFields
$filterTransformers
protected
mixed
$filterTransformers
$formFilters
protected
mixed
$formFilters
$limit
protected
mixed
$limit
$loaded
protected
mixed
$loaded
$logic_operators
protected
mixed
$logic_operators
$operators
protected
mixed
$operators
$order
protected
mixed
$order
$orderCommands
protected
mixed
$orderCommands
$transformCallback
protected
mixed
$transformCallback
Methods
onReload()
Load the datagrid with the database objects
public
onReload([mixed $param = NULL ]) : mixed
Parameters
- $param : mixed = NULL
onSearch()
Register the filter in the session
public
onSearch([mixed $param = null ]) : mixed
Parameters
- $param : mixed = null
show()
method show() Shows the page
public
show() : mixed
addFilterField()
method addFilterField() Add a field that will be used for filtering
protected
addFilterField(mixed $filterField[, mixed $operator = 'like' ][, mixed $formFilter = NULL ][, mixed $filterTransformer = NULL ][, mixed $logic_operator = TExpression::AND_OPERATOR ]) : mixed
Parameters
- $filterField : mixed
-
Field name
- $operator : mixed = 'like'
-
Comparison operator
- $formFilter : mixed = NULL
- $filterTransformer : mixed = NULL
- $logic_operator : mixed = TExpression::AND_OPERATOR
clearFilters()
clear Filters
protected
clearFilters() : mixed
enableTransactionDebug()
Enable Debug
protected
enableTransactionDebug() : mixed
setAfterLoadCallback()
Define a callback method to transform objects before load them into datagrid
protected
setAfterLoadCallback(mixed $callback) : mixed
Parameters
- $callback : mixed
setAfterSearchCallback()
Define a callback method to transform objects after search action
protected
setAfterSearchCallback(mixed $callback) : mixed
Parameters
- $callback : mixed
setCollectionObject()
Set list widget
protected
setCollectionObject(mixed $object) : mixed
Parameters
- $object : mixed
setCriteria()
method setCriteria() Define the criteria
protected
setCriteria(mixed $criteria) : mixed
Parameters
- $criteria : mixed
setDefaultOrder()
Define the default order
protected
setDefaultOrder(mixed $order[, mixed $direction = 'asc' ]) : mixed
Parameters
- $order : mixed
-
The order field
- $direction : mixed = 'asc'
setFilterField()
method setFilterField() Define wich field will be used for filtering PS: Just for Backwards compatibility
protected
setFilterField(mixed $filterField) : mixed
Parameters
- $filterField : mixed
setLimit()
method setLimit() Define the record limit
protected
setLimit(mixed $limit) : mixed
Parameters
- $limit : mixed
setOperator()
method setOperator() Define the filtering operator PS: Just for Backwards compatibility
protected
setOperator(mixed $operator) : mixed
Parameters
- $operator : mixed
setOrderCommand()
Set order command
protected
setOrderCommand(mixed $order_column, mixed $order_command) : mixed
Parameters
- $order_column : mixed
- $order_command : mixed
setTransformer()
Define a callback method to transform objects before load them into datagrid
protected
setTransformer(mixed $callback) : mixed
Parameters
- $callback : mixed