|
dolibarr 20.0.2
|
This class help you create setup render. More...
Public Member Functions | |
| __construct ($db, $outputLangs=null) | |
| Constructor. | |
| generateOutput ($editMode=false, $hideTitle=false) | |
| Generate the form (in read or edit mode depending on $editMode) | |
| generateTableOutput ($editMode=false, $hideTitle=false) | |
| generateTableOutput | |
| saveConfFromPost ($noMessageInUpdate=false) | |
| saveConfFromPost | |
| generateLineOutput ($item, $editMode=false) | |
| generateLineOutput | |
| addItemsFromParamsArray ($params) | |
| Method used to test module builder conversion to this form usage. | |
| addItemFromParams ($confKey, $params) | |
| From old Method was used to test module builder conversion to this form usage. | |
| exportItemsAsParamsArray () | |
| Used to export param array for /core/actions_setmoduleoptions.inc.php template Method exists only for manage setup conversion. | |
| reloadConfs () | |
| Reload for each item default conf note: this will override custom configuration. | |
| newItem ($confKey, $targetItemKey='', $insertAfterTarget=false) | |
| Create a new item The target is useful with hooks : that allow externals modules to add setup items on good place. | |
| sortingItems () | |
| Sort items according to rank. | |
| getCurentItemMaxRank ($cache=true) | |
| getCurentItemMaxRank | |
| setItemMaxRank ($rank) | |
| set new max rank if needed | |
| getLineRank ($itemKey) | |
| get item position rank from item key | |
| itemSort (FormSetupItem $a, FormSetupItem $b) | |
| uasort callback function to Sort params items | |
Static Public Member Functions | |
| static | generateAttributesStringFromArray ($attributes) |
| Generate an attributes string form an input array. | |
This class help you create setup render.
Definition at line 22 of file html.formsetup.class.php.
| FormSetup::__construct | ( | $db, | |
| $outputLangs = null ) |
| FormSetup::addItemFromParams | ( | $confKey, | |
| $params ) |
From old Method was used to test module builder conversion to this form usage.
| string | $confKey | the conf name to store |
| array | $params | an array of params from old modulBuilder params |
@scrutinizer ignore-deprecated
Definition at line 382 of file html.formsetup.class.php.
Referenced by addItemsFromParamsArray().
| FormSetup::addItemsFromParamsArray | ( | $params | ) |
Method used to test module builder conversion to this form usage.
| array | $params | an array of arrays of params from old modulBuilder params |
Definition at line 362 of file html.formsetup.class.php.
References addItemFromParams().
| FormSetup::exportItemsAsParamsArray | ( | ) |
Used to export param array for /core/actions_setmoduleoptions.inc.php template Method exists only for manage setup conversion.
Definition at line 424 of file html.formsetup.class.php.
|
static |
Generate an attributes string form an input array.
| array | $attributes | an array of attributes keys and values, |
Definition at line 122 of file html.formsetup.class.php.
References dol_escape_htmltag().
Referenced by generateOutput().
| FormSetup::generateLineOutput | ( | $item, | |
| $editMode = false ) |
generateLineOutput
| FormSetupItem | $item | the setup item |
| bool | $editMode | Display as edit mod |
Definition at line 317 of file html.formsetup.class.php.
References setEventMessages().
Referenced by generateTableOutput().
| FormSetup::generateOutput | ( | $editMode = false, | |
| $hideTitle = false ) |
Generate the form (in read or edit mode depending on $editMode)
| bool | $editMode | true will display output on edit mod |
| bool | $hideTitle | True to hide the first title line |
Definition at line 145 of file html.formsetup.class.php.
References dol_escape_htmltag(), generateAttributesStringFromArray(), generateTableOutput(), and setEventMessages().
| FormSetup::generateTableOutput | ( | $editMode = false, | |
| $hideTitle = false ) |
generateTableOutput
| bool | $editMode | True will display output on edit modECM |
| bool | $hideTitle | True to hide the first title line |
Definition at line 214 of file html.formsetup.class.php.
References generateLineOutput(), setEventMessages(), and sortingItems().
Referenced by generateOutput().
| FormSetup::getCurentItemMaxRank | ( | $cache = true | ) |
getCurentItemMaxRank
| bool | $cache | To use cache or not |
Definition at line 517 of file html.formsetup.class.php.
Referenced by newItem().
| FormSetup::getLineRank | ( | $itemKey | ) |
get item position rank from item key
| string | $itemKey | the item key |
Definition at line 554 of file html.formsetup.class.php.
| FormSetup::itemSort | ( | FormSetupItem | $a, |
| FormSetupItem | $b ) |
uasort callback function to Sort params items
| FormSetupItem | $a | formSetup item |
| FormSetupItem | $b | formSetup item |
Definition at line 570 of file html.formsetup.class.php.
| FormSetup::newItem | ( | $confKey, | |
| $targetItemKey = '', | |||
| $insertAfterTarget = false ) |
Create a new item The target is useful with hooks : that allow externals modules to add setup items on good place.
| string | $confKey | the conf key used in database |
| string | $targetItemKey | target item used to place the new item beside |
| bool | $insertAfterTarget | insert before or after target item ? |
Definition at line 465 of file html.formsetup.class.php.
References getCurentItemMaxRank(), and setItemMaxRank().
| FormSetup::reloadConfs | ( | ) |
Reload for each item default conf note: this will override custom configuration.
Definition at line 443 of file html.formsetup.class.php.
| FormSetup::saveConfFromPost | ( | $noMessageInUpdate = false | ) |
saveConfFromPost
| bool | $noMessageInUpdate | display event message on errors and success |
Definition at line 260 of file html.formsetup.class.php.
References setEventMessages().
| FormSetup::setItemMaxRank | ( | $rank | ) |
set new max rank if needed
| int | $rank | the item rank |
Definition at line 542 of file html.formsetup.class.php.
Referenced by newItem().
| FormSetup::sortingItems | ( | ) |
Sort items according to rank.
Definition at line 505 of file html.formsetup.class.php.
Referenced by generateTableOutput().