jFormsDynamicStaticDatasource
extends jFormsDynamicDatasource
in package
A datasource which is based on a list of associative array
Tags
Table of Contents
- $data : array<string|int, array<string|int, mixed>>
- array of associative array which contains keys, labels and other values that can serve as filters.
- $criteriaFrom : mixed
- $filterKeysMapping : array<string|int, mixed>
- $groupeBy : mixed
- $keyKey : string
- $labelKeys : array<string|int, string>
- List of array keys that can serve as labels.
- $labelSeparator : string
- Separator to glue labels
- __construct() : mixed
- getCriteriaControls() : array<string|int, string>
- Return the list of controls name that provide criterion values.
- getData() : mixed
- getLabel() : mixed
- getLabel2() : mixed
- hasGroupedData() : mixed
- setCriteriaControls() : mixed
- set the list of controls name that provide criterion values.
- setFilterKeysMapping() : mixed
- setGroupBy() : mixed
- setKeyAndLabelKeys() : mixed
- buildLabel() : mixed
- filterWithCriteria() : mixed
Properties
$data
array of associative array which contains keys, labels and other values that can serve as filters.
public
array<string|int, array<string|int, mixed>>
$data
= array()
Tags
$criteriaFrom
protected
mixed
$criteriaFrom
Tags
$filterKeysMapping
protected
array<string|int, mixed>
$filterKeysMapping
= array()
mapping for criterias : form control name => key of the array item
Tags
$groupeBy
protected
mixed
$groupeBy
= ''
Tags
$keyKey
protected
string
$keyKey
= 'value'
the array key that contain the key value
Tags
$labelKeys
List of array keys that can serve as labels.
protected
array<string|int, string>
$labelKeys
= array('label')
Tags
$labelSeparator
Separator to glue labels
protected
string
$labelSeparator
= ''
Tags
Methods
__construct()
public
__construct(mixed $formid) : mixed
Parameters
- $formid : mixed
Tags
Return values
mixed —getCriteriaControls()
Return the list of controls name that provide criterion values.
public
getCriteriaControls() : array<string|int, string>
Tags
Return values
array<string|int, string> —getData()
public
getData(mixed $form) : mixed
Parameters
- $form : mixed
Tags
Return values
mixed —getLabel()
public
getLabel(mixed $key) : mixed
Parameters
- $key : mixed
Tags
Return values
mixed —getLabel2()
public
getLabel2(mixed $key, mixed $form) : mixed
Parameters
- $key : mixed
- $form : mixed
Tags
Return values
mixed —hasGroupedData()
public
hasGroupedData() : mixed
Tags
Return values
mixed —setCriteriaControls()
set the list of controls name that provide criterion values.
public
setCriteriaControls([mixed $criteriaFrom = null ]) : mixed
Parameters
- $criteriaFrom : mixed = null
Tags
Return values
mixed —setFilterKeysMapping()
public
setFilterKeysMapping(array<string|int, mixed> $mapping) : mixed
Parameters
- $mapping : array<string|int, mixed>
Tags
Return values
mixed —setGroupBy()
public
setGroupBy(mixed $group) : mixed
Parameters
- $group : mixed
Tags
Return values
mixed —setKeyAndLabelKeys()
public
setKeyAndLabelKeys(mixed $keyName, array<string|int, mixed> $labelKeyNames[, mixed $separator = ',' ]) : mixed
Parameters
- $keyName : mixed
- $labelKeyNames : array<string|int, mixed>
- $separator : mixed = ','
Tags
Return values
mixed —buildLabel()
protected
buildLabel(mixed $rec) : mixed
Parameters
- $rec : mixed
Tags
Return values
mixed —filterWithCriteria()
protected
filterWithCriteria(jFormsBase $form) : mixed
Parameters
- $form : jFormsBase