Class Constructor
__construct
($name, $label, $align, [$width = NULL])
-
$name: = Name of the column in the database
-
$label: = Text label that will be shown in the header
-
$align: = Column align (left, center, right)
-
$width: = Column Width (pixels)
Enable column auto hide
enableAutoHide
($width)
Enable column search
enableSearch
()
Enable total
enableTotal
($function, [$prefix = null], [$decimals = 2], [$decimal_separator = ','], [$thousand_separator = '.'])
-
$function
-
$prefix
-
$decimals
-
$decimal_separator
-
$thousand_separator
Returns the action defined by set_action() method
getAction
()
Returns the column's align
getAlign
()
Return data properties
getDataProperties
()
Return a data property
getDataProperty
($name)
Returns the action defined by setEditAction() method
getEditAction
()
Get input search
getInputSearch
()
Returns the column's label
getLabel
()
Returns the database column's name
getName
()
Return column properties
getProperties
()
Return a column property
getProperty
($name)
Returns the callback defined by the setTotalFunction()
getTotalCallback
()
Returns total function
getTotalFunction
()
Returns total mask
getTotalMask
()
Returns the callback defined by the setTransformer()
getTransformer
()
Returns the column's width
getWidth
()
Returns if column is searchable
isSearchable
()
Remove action
removeAction
()
Define the action to be executed when
the user clicks over the column header
setAction
($action, [$parameters = null])
-
$action: TAction object
-
$parameters: Action parameters
Define a data property
setDataProperty
($name, $value)
-
$name: Property Name
-
$value: Property Value
Define the action to be executed when
the user clicks do edit the column
setEditAction
($editaction)
-
$editaction: A TDataGridAction object
Set the column's label
setLabel
($label)
Define a column header property
setProperty
($name, $value)
-
$name: Property Name
-
$value: Property Value
Define a callback function to totalize column
setTotalFunction
(Callable$callback, [$apply_transformer = true])
-
Callable$callback: A function name of a method of an object
-
$apply_transformer: Apply transform function also in total
Define a callback function to be applyed over the column's data
setTransformer
(Callable$callback)
-
Callable$callback: A function name of a method of an object
Define column visibility
setVisibility
($bool)
Is total transformed
totalTransformed
()
Intercepts whenever someones assign a new property's value
__set
($name, $value)
-
$name: Property Name
-
$value: Property Value