DataTable

Class DataTable

Output

Dynamic DataTable

Static DataTable

Twig Tag

Tag: UIDataTable
Syntax

{% UIDataTable Type {Parameters} %}
    Content Goes Here
{% EndUIDataTable %}

Type

ForResult	@param WebPage $oPage
ForObject	@param WebPage $oPage
ActionRowToolbarTemplate	Make a row actions toolbar template.
ForRendering	Make a basis Panel component
ForRenderingObject	@param string $sListId
ForStaticData	@param string $sTitle
ForForm	@param string $sRef

DataTable ForResult

syntax

{% UIDataTable ForResult {oPage:value, sListId:'value', oSet:value, aExtraParams:value} %}
    Content Goes Here
{% EndUIDataTable %}

parameters

oPage	WebPage	mandatory
sListId	string	mandatory
oSet	DBObjectSet	mandatory
aExtraParams		optional	array ()

DataTable ForObject

syntax

{% UIDataTable ForObject {oPage:value, sListId:'value', oSet:value, aExtraParams:value} %}
    Content Goes Here
{% EndUIDataTable %}

parameters

oPage	WebPage	mandatory
sListId	string	mandatory
oSet	DBObjectSet	mandatory
aExtraParams		optional	array ()

DataTable ActionRowToolbarTemplate

syntax

{% UIDataTable ActionRowToolbarTemplate {oTable:value} %}
    Content Goes Here
{% EndUIDataTable %}

parameters

oTable

iUIBlock

mandatory

datatable object that needs to use tTableRowActions trait

DataTable ForRendering

syntax

{% UIDataTable ForRendering {sListId:'value', oSet:value, aExtraParams:value} %}
    Content Goes Here
{% EndUIDataTable %}

parameters

sListId	string	mandatory
oSet	DBObjectSet	mandatory
aExtraParams		optional	array ()

DataTable ForRenderingObject

syntax

{% UIDataTable ForRenderingObject {sListId:'value', oSet:value, aExtraParams:value} %}
    Content Goes Here
{% EndUIDataTable %}

parameters

sListId	string	mandatory
oSet	DBObjectSet	mandatory
aExtraParams		optional	array ()

DataTable ForStaticData

syntax

{% UIDataTable ForStaticData {sTitle:'value', aColumns:{name:value, name:value}, aData:{name:value, name:value}, sId:'value', aExtraParams:{name:value, name:value}, sFilter:'value', aOptions:{name:value, name:value}, aRowActions:{name:value, name:value}} %}
    Content Goes Here
{% EndUIDataTable %}

parameters

sTitle	string	mandatory
aColumns	array	mandatory
aData	array	mandatory
sId	string	optional	NULL
aExtraParams	array	optional	array ()
sFilter	string	optional	‘’
aOptions	array	optional	array ()
aRowActions	array	optional	NULL	@since 3.1.0

DataTable ForForm

syntax

{% UIDataTable ForForm {sRef:'value', aColumns:{name:value, name:value}, aData:{name:value, name:value}, sFilter:'value', aRowActions:{name:value, name:value}} %}
    Content Goes Here
{% EndUIDataTable %}

parameters

sRef	string	mandatory
aColumns	array	mandatory
aData	array	optional	array ()
sFilter	string	optional	‘’
aRowActions	array	optional	NULL	@since 3.1.0

DataTable common parameters

AddCSSClass	string	CSS class to add to the generated html block
AddCSSClasses	array	like <code>[‘ibo-is-hidden’, ‘ibo-alert–body’]</code>
AddCssFileRelPath	string
AddDeferredBlock	iUIBlock
AddHtml	string
AddJsFileRelPath	string
AddMultipleCssFilesRelPaths	array
AddMultipleJsFilesRelPaths	array
AddSubBlock	iUIBlock
AjaxData	array
AjaxUrl	string
CSSClasses	array	like <code>[‘ibo-is-hidden’, ‘ibo-alert–body’]</code>
DataAttributes	array	Array of data attributes in the format [‘name’ => ‘value’]
DeferredBlocks	array
DisplayColumns
HasForcedDiv	bool
InitDisplayData	array
IsHidden	bool
JSRefresh	string
Options
ResultColumns
RowActions	array
SubBlocks	array

The columns (aColumns) have the following format:

[
    'nameField1' => ['label' => labelField1, 'description' => descriptionField1],
    ...
]

The data (aData) format has to be:

[
    ['nameField1' => valueField1, 'nameField2' => valueField2, ...],
    ...
]

Examples

No examples provided yet