|
dolibarr 19.0.4
|
This class help you create setup render. More...
Public Member Functions | |
| __construct ($db, $outputLangs=null) | |
| Constructor. | |
| generateOutput ($editMode=false) | |
| generateOutput | |
| generateTableOutput ($editMode=false) | |
| generateTableOutput | |
| saveConfFromPost ($noMessageInUpdate=false) | |
| saveConfFromPost | |
| generateLineOutput ($item, $editMode=false) | |
| generateLineOutput | |
| addItemsFromParamsArray ($params) | |
| Method used to test module builder convertion to this form usage. | |
| addItemFromParams ($confKey, $params) | |
| From old Method was used to test module builder convertion to this form usage. | |
| exportItemsAsParamsArray () | |
| Used to export param array for /core/actions_setmoduleoptions.inc.php template Method exists only for manage setup convertion. | |
| reloadConfs () | |
| Reload for each item default conf note: this will override custom configuration. | |
| newItem ($confKey, $targetItemKey='', $insertAfterTarget=false) | |
| Create a new item the tagret 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 ) |
Constructor.
Definition at line 94 of file html.formsetup.class.php.
| FormSetup::addItemFromParams | ( | $confKey, | |
| $params ) |
From old Method was used to test module builder convertion 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 377 of file html.formsetup.class.php.
Referenced by addItemsFromParamsArray().
| FormSetup::addItemsFromParamsArray | ( | $params | ) |
Method used to test module builder convertion to this form usage.
| array | $params | an array of arrays of params from old modulBuilder params |
Definition at line 357 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 convertion.
Definition at line 418 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 121 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 312 of file html.formsetup.class.php.
References setEventMessages().
Referenced by generateTableOutput().
| FormSetup::generateOutput | ( | $editMode = false | ) |
generateOutput
| bool | $editMode | true will display output on edit mod |
Definition at line 143 of file html.formsetup.class.php.
References dol_escape_htmltag(), generateAttributesStringFromArray(), generateTableOutput(), and setEventMessages().
| FormSetup::generateTableOutput | ( | $editMode = false | ) |
generateTableOutput
| bool | $editMode | true will display output on edit mod |
Definition at line 210 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 511 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 548 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 564 of file html.formsetup.class.php.
| FormSetup::newItem | ( | $confKey, | |
| $targetItemKey = '', | |||
| $insertAfterTarget = false ) |
Create a new item the tagret 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 459 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 437 of file html.formsetup.class.php.
| FormSetup::saveConfFromPost | ( | $noMessageInUpdate = false | ) |
saveConfFromPost
| bool | $noMessageInUpdate | display event message on errors and success |
Definition at line 254 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 536 of file html.formsetup.class.php.
Referenced by newItem().
| FormSetup::sortingItems | ( | ) |
Sort items according to rank.
Definition at line 499 of file html.formsetup.class.php.
Referenced by generateTableOutput().