DataTable¶
Class DataTable
Twig Tag¶
| Tag: | UIDataTable |
|---|---|
| Syntax: |
{% UIDataTable Type {Parameters} %}
Content Goes Here
{% EndUIDataTable %}
| Type: |
|---|
| ForResult | @param WebPage $oPage |
| ForObject | @param WebPage $oPage |
| 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 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}} %}
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 () |
DataTable ForForm¶
| syntax: |
|---|
{% UIDataTable ForForm {sRef:'value', aColumns:{name:value, name:value}, aData:{name:value, name:value}, sFilter:'value'} %}
Content Goes Here
{% EndUIDataTable %}
| parameters: |
|---|
| sRef | string | mandatory | ||
| aColumns | array | mandatory | ||
| aData | array | optional | array () | |
| sFilter | string | optional | ‘’ |
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 | ||
| InitDisplayData | array | |
| IsHidden | bool | Indicates if the block is hidden by default |
| JSRefresh | string | |
| Options | ||
| ResultColumns | ||
| 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