|
dolibarr 24.0.0-beta
|
This class help to create item for class formSetup. More...
Public Member Functions | |
| __construct ($confKey) | |
| Constructor. | |
| loadValueFromConf () | |
| load conf value from databases | |
| reloadValueFromConf () | |
| Reload conf value from databases is an alias of loadValueFromConf. | |
| saveConfValue () | |
| Save const value based on htdocs/core/actions_setmoduleoptions.inc.php. | |
| setSaveCallBack (callable $callBack) | |
| Set an override function for saving data. | |
| setValueFromPostCallBack (callable $callBack) | |
| Set an override function for get data from post. | |
| setValueFromPost () | |
| Save const value based on htdocs/core/actions_setmoduleoptions.inc.php. | |
| getHelpText () | |
| Get help text or generate it. | |
| getNameText () | |
| Get field name text or generate it. | |
| generateInputField () | |
| generate input field | |
| generateInputFieldText () | |
| Generate default input field. | |
| generateInputFieldPrice () | |
| Generate default input field. | |
| generateInputFieldEmail () | |
| Generate default input field. | |
| generateInputFieldUrl () | |
| Generate default input field. | |
| generateInputFieldTextarea () | |
| generate input field for textarea | |
| generateInputFieldHtml () | |
| generate input field for html | |
| generateInputFieldCategories () | |
| generate input field for categories | |
| generateInputFieldEmailTemplate () | |
| generate input field for email template selector | |
| generateInputFieldSecureKey () | |
| generate input field for secure key | |
| generateInputFieldPassword ($type='generic', $defaultmin=6, $defaultmax=50) | |
| generate input field for a password | |
| generateInputFieldMultiSelect () | |
| generateInputFieldMultiSelect | |
| generateInputFieldSelect () | |
| generateInputFieldSelect | |
| generateInputFieldRadio () | |
| generateInputFieldSelect | |
| generateInputFieldSelectUser () | |
| getType () | |
| get the type : used for old module builder setup conf style conversion and tests because this two class will quickly evolve it's important to not set or get directly $this->type (will be protected) so this method exist to be sure we can manage evolution easily | |
| setTypeFromTypeString ($type) | |
| set the type from string : used for old module builder setup conf style conversion and tests because this two class will quickly evolve it's important to not set directly $this->type (will be protected) so this method exist to be sure we can manage evolution easily | |
| setErrors ($errors) | |
| Add error. | |
| generateOutputField () | |
| generateOutputField | |
| generateOutputFieldMultiSelect () | |
| generateOutputFieldMultiSelect | |
| generateOutputFieldColor () | |
| generateOutputFieldColor | |
| generateInputFieldColor () | |
| generateInputFieldColor | |
| generateOutputFieldSelect () | |
| generateOutputFieldSelect | |
| generateOutputFieldSelectUser () | |
| generateOutputFieldSelectUser | |
| setAsString () | |
| Set type of input as string. | |
| setAsNumber ($min=null, $max=null, $step=null) | |
| Set type of input as number. | |
| setAsEmail () | |
| Set type of input as string. | |
| setAsUrl () | |
| Set type of input as string. | |
| setAsColor () | |
| Set type of input as color. | |
| setAsTextarea () | |
| Set type of input as textarea. | |
| setAsHtml () | |
| Set type of input as html editor. | |
| setAsEmailTemplate ($templateType) | |
| Set type of input as emailtemplate selector. | |
| setAsThirdpartyType () | |
| Set type of input as thirdparty_type selector. | |
| setAsYesNo () | |
| Set type of input as Yes. | |
| setAsSecureKey () | |
| Set type of input as secure key. | |
| setAsProduct () | |
| Set type of input as product. | |
| setAsPrice () | |
| Set type of input as product. | |
| setAsCategory ($catType) | |
| Set type of input as a category selector TODO add default value. | |
| setAsTitle () | |
| Set type of input as a simple title. | |
| setAsMultiSelect ($fieldOptions) | |
| Set type of input as a multiselect list. | |
| setAsSelect ($fieldOptions) | |
| Set type of input as a select list. | |
| setAsRadio ($fieldOptions) | |
| Set type of input as a radio button. | |
| setAsSelectUser () | |
| Set type of input as a selection of a user from dolibarr users list. | |
| setAsSelectBankAccount () | |
| Set type of input as a bank account selection from dolibarr bank accounts list. | |
| setAsPassword () | |
| Set type of input as a password with dolibarr password rules apply. | |
| setAsGenericPassword () | |
| Set type of input as a generic password without dolibarr password rules (for external passwords for example). | |
This class help to create item for class formSetup.
Definition at line 628 of file html.formsetup.class.php.
| FormSetupItem::__construct | ( | $confKey | ) |
Constructor.
| string | $confKey | the conf key used in database |
Definition at line 724 of file html.formsetup.class.php.
References $conf, $db, and loadValueFromConf().
| FormSetupItem::generateInputField | ( | ) |
generate input field
Definition at line 913 of file html.formsetup.class.php.
References $conf, fieldInputCallBack, img_picto(), isModEnabled(), and type.
| FormSetupItem::generateInputFieldCategories | ( | ) |
generate input field for categories
Definition at line 1108 of file html.formsetup.class.php.
References img_picto(), and type.
| FormSetupItem::generateInputFieldColor | ( | ) |
generateInputFieldColor
Definition at line 1504 of file html.formsetup.class.php.
References colorArrayToHex(), and colorStringToArray().
| FormSetupItem::generateInputFieldEmail | ( | ) |
Generate default input field.
Definition at line 1057 of file html.formsetup.class.php.
References FormSetup\generateAttributesStringFromArray(), and img_picto().
| FormSetupItem::generateInputFieldEmailTemplate | ( | ) |
generate input field for email template selector
Definition at line 1130 of file html.formsetup.class.php.
References type.
| FormSetupItem::generateInputFieldHtml | ( | ) |
generate input field for html
Definition at line 1096 of file html.formsetup.class.php.
References isModEnabled().
| FormSetupItem::generateInputFieldMultiSelect | ( | ) |
generateInputFieldMultiSelect
Definition at line 1228 of file html.formsetup.class.php.
| FormSetupItem::generateInputFieldPassword | ( | $type = 'generic', | |
| $defaultmin = 6, | |||
| $defaultmax = 50 ) |
generate input field for a password
| string | $type | 'dolibarr' (dolibarr password rules apply) or 'generic' |
| int | $defaultmin | Min nb of chars |
| int | $defaultmax | Max nb of chars |
Definition at line 1189 of file html.formsetup.class.php.
References $conf, getDolGlobalString(), and GETPOST().
| FormSetupItem::generateInputFieldPrice | ( | ) |
Generate default input field.
Definition at line 1041 of file html.formsetup.class.php.
References $mysoc.
| FormSetupItem::generateInputFieldRadio | ( | ) |
generateInputFieldSelect
Definition at line 1260 of file html.formsetup.class.php.
References img_picto().
| FormSetupItem::generateInputFieldSecureKey | ( | ) |
generate input field for secure key
Definition at line 1164 of file html.formsetup.class.php.
References $conf, dolJSToSetRandomPassword(), and GETPOST().
| FormSetupItem::generateInputFieldSelect | ( | ) |
generateInputFieldSelect
Definition at line 1243 of file html.formsetup.class.php.
References img_picto().
| FormSetupItem::generateInputFieldSelectUser | ( | ) |
Definition at line 1275 of file html.formsetup.class.php.
| FormSetupItem::generateInputFieldText | ( | ) |
Generate default input field.
Definition at line 1028 of file html.formsetup.class.php.
| FormSetupItem::generateInputFieldTextarea | ( | ) |
generate input field for textarea
Definition at line 1083 of file html.formsetup.class.php.
References dol_htmlentities().
| FormSetupItem::generateInputFieldUrl | ( | ) |
Generate default input field.
Definition at line 1070 of file html.formsetup.class.php.
References FormSetup\generateAttributesStringFromArray(), and img_picto().
| FormSetupItem::generateOutputField | ( | ) |
generateOutputField
Definition at line 1333 of file html.formsetup.class.php.
References $c, $conf, dol_nl2br(), dolPrintHTML(), and type.
| FormSetupItem::generateOutputFieldColor | ( | ) |
generateOutputFieldColor
Definition at line 1476 of file html.formsetup.class.php.
References colorArrayToHex(), and colorStringToArray().
| FormSetupItem::generateOutputFieldMultiSelect | ( | ) |
generateOutputFieldMultiSelect
Definition at line 1453 of file html.formsetup.class.php.
| FormSetupItem::generateOutputFieldSelect | ( | ) |
| FormSetupItem::generateOutputFieldSelectUser | ( | ) |
generateOutputFieldSelectUser
Definition at line 1533 of file html.formsetup.class.php.
| FormSetupItem::getHelpText | ( | ) |
Get help text or generate it.
Definition at line 880 of file html.formsetup.class.php.
| FormSetupItem::getNameText | ( | ) |
Get field name text or generate it.
Definition at line 893 of file html.formsetup.class.php.
References img_picto(), and isModEnabled().
| FormSetupItem::getType | ( | ) |
get the type : used for old module builder setup conf style conversion and tests because this two class will quickly evolve it's important to not set or get directly $this->type (will be protected) so this method exist to be sure we can manage evolution easily
Definition at line 1287 of file html.formsetup.class.php.
| FormSetupItem::loadValueFromConf | ( | ) |
load conf value from databases
Definition at line 747 of file html.formsetup.class.php.
References $conf.
Referenced by __construct().
| FormSetupItem::reloadValueFromConf | ( | ) |
Reload conf value from databases is an alias of loadValueFromConf.
Definition at line 765 of file html.formsetup.class.php.
| FormSetupItem::saveConfValue | ( | ) |
Save const value based on htdocs/core/actions_setmoduleoptions.inc.php.
Definition at line 776 of file html.formsetup.class.php.
References dolibarr_set_const(), and type.
| FormSetupItem::setAsCategory | ( | $catType | ) |
Set type of input as a category selector TODO add default value.
| string | $catType | Type of category ('customer', 'supplier', 'contact', 'product', 'member'). Old mode (0, 1, 2, ...) is deprecated. |
Definition at line 1711 of file html.formsetup.class.php.
References type.
| FormSetupItem::setAsColor | ( | ) |
Set type of input as color.
Definition at line 1609 of file html.formsetup.class.php.
References type.
| FormSetupItem::setAsEmail | ( | ) |
Set type of input as string.
Definition at line 1587 of file html.formsetup.class.php.
References type.
| FormSetupItem::setAsEmailTemplate | ( | $templateType | ) |
Set type of input as emailtemplate selector.
| string | $templateType | email template type |
Definition at line 1643 of file html.formsetup.class.php.
References type.
| FormSetupItem::setAsGenericPassword | ( | ) |
Set type of input as a generic password without dolibarr password rules (for external passwords for example).
Hide entry on display.
Definition at line 1820 of file html.formsetup.class.php.
References type.
| FormSetupItem::setAsHtml | ( | ) |
Set type of input as html editor.
Definition at line 1631 of file html.formsetup.class.php.
References type.
| FormSetupItem::setAsMultiSelect | ( | $fieldOptions | ) |
Set type of input as a multiselect list.
| array<int|string,string|array{id:string,label:string,color:string,picto:string,labelhtml:string}> | $fieldOptions A table of field options |
Definition at line 1735 of file html.formsetup.class.php.
References type.
| FormSetupItem::setAsNumber | ( | $min = null, | |
| $max = null, | |||
| $step = null ) |
Set type of input as number.
| int | $min | minimum value for input number |
| int | $max | maximum value for input number |
| int | $step | legal number intervals |
Definition at line 1565 of file html.formsetup.class.php.
References type.
| FormSetupItem::setAsPassword | ( | ) |
Set type of input as a password with dolibarr password rules apply.
Hide entry on display.
Definition at line 1807 of file html.formsetup.class.php.
References type.
| FormSetupItem::setAsPrice | ( | ) |
Set type of input as product.
Definition at line 1698 of file html.formsetup.class.php.
References type.
| FormSetupItem::setAsProduct | ( | ) |
Set type of input as product.
Definition at line 1687 of file html.formsetup.class.php.
References type.
| FormSetupItem::setAsRadio | ( | $fieldOptions | ) |
Set type of input as a radio button.
| ?array<int|string,string|array{id:string,label:string,picto?:string,labelIsHtml?:bool}> | $fieldOptions A table of field options |
Definition at line 1768 of file html.formsetup.class.php.
References type.
| FormSetupItem::setAsSecureKey | ( | ) |
Set type of input as secure key.
Definition at line 1676 of file html.formsetup.class.php.
References type.
| FormSetupItem::setAsSelect | ( | $fieldOptions | ) |
Set type of input as a select list.
| ?array<int|string,string|array{id:string,label:string,color:string,picto:string,labelhtml:string,note:string}> | $fieldOptions A table of field options |
Definition at line 1751 of file html.formsetup.class.php.
References type.
| FormSetupItem::setAsSelectBankAccount | ( | ) |
Set type of input as a bank account selection from dolibarr bank accounts list.
Definition at line 1794 of file html.formsetup.class.php.
References type.
| FormSetupItem::setAsSelectUser | ( | ) |
Set type of input as a selection of a user from dolibarr users list.
Definition at line 1783 of file html.formsetup.class.php.
References type.
| FormSetupItem::setAsString | ( | ) |
Set type of input as string.
Definition at line 1551 of file html.formsetup.class.php.
References type.
| FormSetupItem::setAsTextarea | ( | ) |
Set type of input as textarea.
Definition at line 1620 of file html.formsetup.class.php.
References type.
| FormSetupItem::setAsThirdpartyType | ( | ) |
Set type of input as thirdparty_type selector.
Definition at line 1654 of file html.formsetup.class.php.
References type.
| FormSetupItem::setAsTitle | ( | ) |
Set type of input as a simple title.
No data to store
Definition at line 1722 of file html.formsetup.class.php.
References type.
| FormSetupItem::setAsUrl | ( | ) |
Set type of input as string.
Definition at line 1598 of file html.formsetup.class.php.
References type.
| FormSetupItem::setAsYesNo | ( | ) |
Set type of input as Yes.
Definition at line 1665 of file html.formsetup.class.php.
References type.
| FormSetupItem::setErrors | ( | $errors | ) |
Add error.
| string[] | string | $errors | the error text |
Definition at line 1314 of file html.formsetup.class.php.
| FormSetupItem::setSaveCallBack | ( | callable | $callBack | ) |
Set an override function for saving data.
| callable | $callBack | a callable function |
Definition at line 814 of file html.formsetup.class.php.
| FormSetupItem::setTypeFromTypeString | ( | $type | ) |
set the type from string : used for old module builder setup conf style conversion and tests because this two class will quickly evolve it's important to not set directly $this->type (will be protected) so this method exist to be sure we can manage evolution easily
| string | $type | Possible values based on old module builder setup : 'string', 'textarea', 'category:'.Categorie\TYPE_CUSTOMER', 'emailtemplate', 'thirdparty_type' |
Definition at line 1301 of file html.formsetup.class.php.
References type.
| FormSetupItem::setValueFromPost | ( | ) |
Save const value based on htdocs/core/actions_setmoduleoptions.inc.php.
Definition at line 835 of file html.formsetup.class.php.
References GETPOST(), GETPOSTINT(), and type.
| FormSetupItem::setValueFromPostCallBack | ( | callable | $callBack | ) |
Set an override function for get data from post.
| callable | $callBack | a callable function |
Definition at line 825 of file html.formsetup.class.php.