dolibarr 20.0.0
FormSetupItem Class Reference

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 ()
 generatec 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')
 generate input field for a password
 
 generateInputFieldMultiSelect ()
 generateInputFieldMultiSelect
 
 generateInputFieldSelect ()
 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.
 
 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.
 
 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 simple title.
 
 setAsSelect ($fieldOptions)
 Set type of input as a simple title.
 
 setAsSelectUser ()
 Set type of input as a simple title.
 
 setAsSelectBankAccount ()
 Set type of input as a simple title.
 
 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).
 

Public Attributes

 $rank = 0
 

 
 $saveCallBack
 

 
 $setValueFromPostCallBack
 

 

Detailed Description

This class help to create item for class formSetup.

Definition at line 589 of file html.formsetup.class.php.

Constructor & Destructor Documentation

◆ __construct()

FormSetupItem::__construct ( $confKey)

Constructor.

Parameters
string$confKeythe conf key used in database

Definition at line 676 of file html.formsetup.class.php.

References loadValueFromConf().

Member Function Documentation

◆ generateInputField()

FormSetupItem::generateInputField ( )

generate input field

Returns
bool|string

Definition at line 862 of file html.formsetup.class.php.

References type.

◆ generateInputFieldCategories()

FormSetupItem::generateInputFieldCategories ( )

generate input field for categories

Returns
string

Definition at line 981 of file html.formsetup.class.php.

References img_picto(), and type.

◆ generateInputFieldColor()

FormSetupItem::generateInputFieldColor ( )

generateInputFieldColor

Returns
string

Definition at line 1332 of file html.formsetup.class.php.

References colorArrayToHex(), and colorStringToArray().

◆ generateInputFieldEmailTemplate()

FormSetupItem::generateInputFieldEmailTemplate ( )

generate input field for email template selector

Returns
string

Definition at line 1003 of file html.formsetup.class.php.

References type.

◆ generateInputFieldHtml()

FormSetupItem::generateInputFieldHtml ( )

generate input field for html

Returns
string

Definition at line 968 of file html.formsetup.class.php.

◆ generateInputFieldMultiSelect()

FormSetupItem::generateInputFieldMultiSelect ( )

generateInputFieldMultiSelect

Returns
string

Definition at line 1097 of file html.formsetup.class.php.

◆ generateInputFieldPassword()

FormSetupItem::generateInputFieldPassword ( $type = 'generic')

generate input field for a password

Parameters
string$type'dolibarr' (dolibarr password rules apply) or 'generic'
Returns
string

Definition at line 1061 of file html.formsetup.class.php.

References getDolGlobalString(), and GETPOST().

◆ generateInputFieldSecureKey()

FormSetupItem::generateInputFieldSecureKey ( )

generate input field for secure key

Returns
string

Definition at line 1037 of file html.formsetup.class.php.

References dolJSToSetRandomPassword(), and GETPOST().

◆ generateInputFieldSelect()

FormSetupItem::generateInputFieldSelect ( )

generateInputFieldSelect

Returns
string

Definition at line 1113 of file html.formsetup.class.php.

References img_picto().

◆ generateInputFieldSelectUser()

FormSetupItem::generateInputFieldSelectUser ( )
Returns
string

Definition at line 1127 of file html.formsetup.class.php.

◆ generateInputFieldText()

FormSetupItem::generateInputFieldText ( )

generatec default input field

Returns
string

Definition at line 942 of file html.formsetup.class.php.

◆ generateInputFieldTextarea()

FormSetupItem::generateInputFieldTextarea ( )

generate input field for textarea

Returns
string

Definition at line 955 of file html.formsetup.class.php.

References dol_htmlentities().

◆ generateOutputField()

FormSetupItem::generateOutputField ( )

generateOutputField

Returns
bool|string Generate the output html for this item

Definition at line 1185 of file html.formsetup.class.php.

References dol_nl2br(), and type.

◆ generateOutputFieldColor()

FormSetupItem::generateOutputFieldColor ( )

generateOutputFieldColor

Returns
string

Definition at line 1317 of file html.formsetup.class.php.

References colorArrayToHex(), and colorStringToArray().

◆ generateOutputFieldMultiSelect()

FormSetupItem::generateOutputFieldMultiSelect ( )

generateOutputFieldMultiSelect

Returns
string

Definition at line 1294 of file html.formsetup.class.php.

◆ generateOutputFieldSelect()

FormSetupItem::generateOutputFieldSelect ( )

generateOutputFieldSelect

Returns
string

Definition at line 1346 of file html.formsetup.class.php.

◆ generateOutputFieldSelectUser()

FormSetupItem::generateOutputFieldSelectUser ( )

generateOutputFieldSelectUser

Returns
string

Definition at line 1361 of file html.formsetup.class.php.

◆ getHelpText()

FormSetupItem::getHelpText ( )

Get help text or generate it.

Returns
int|string

Definition at line 829 of file html.formsetup.class.php.

◆ getNameText()

FormSetupItem::getNameText ( )

Get field name text or generate it.

Returns
false|int|string

Definition at line 842 of file html.formsetup.class.php.

References img_picto().

◆ getType()

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

Returns
string

Definition at line 1139 of file html.formsetup.class.php.

◆ loadValueFromConf()

FormSetupItem::loadValueFromConf ( )

load conf value from databases

Returns
bool

Definition at line 699 of file html.formsetup.class.php.

Referenced by __construct().

◆ reloadValueFromConf()

FormSetupItem::reloadValueFromConf ( )

Reload conf value from databases is an alias of loadValueFromConf.

Deprecated
Returns
bool

Definition at line 717 of file html.formsetup.class.php.

◆ saveConfValue()

FormSetupItem::saveConfValue ( )

Save const value based on htdocs/core/actions_setmoduleoptions.inc.php.

Returns
int -1 if KO, 1 if OK

Definition at line 728 of file html.formsetup.class.php.

References dolibarr_set_const(), and type.

◆ setAsCategory()

FormSetupItem::setAsCategory ( $catType)

Set type of input as a category selector TODO add default value.

Parameters
int$catTypeType of category ('customer', 'supplier', 'contact', 'product', 'member'). Old mode (0, 1, 2, ...) is deprecated.
Returns
self

Definition at line 1481 of file html.formsetup.class.php.

References type.

◆ setAsColor()

FormSetupItem::setAsColor ( )

Set type of input as color.

Returns
self

Definition at line 1390 of file html.formsetup.class.php.

References type.

◆ setAsEmailTemplate()

FormSetupItem::setAsEmailTemplate ( $templateType)

Set type of input as emailtemplate selector.

Parameters
string$templateTypeemail template type
Returns
self

Definition at line 1424 of file html.formsetup.class.php.

References type.

◆ setAsGenericPassword()

FormSetupItem::setAsGenericPassword ( )

Set type of input as a generic password without dolibarr password rules (for external passwords for example).

Hide entry on display.

Returns
self

Definition at line 1571 of file html.formsetup.class.php.

References type.

◆ setAsHtml()

FormSetupItem::setAsHtml ( )

Set type of input as html editor.

Returns
self

Definition at line 1412 of file html.formsetup.class.php.

References type.

◆ setAsMultiSelect()

FormSetupItem::setAsMultiSelect ( $fieldOptions)

Set type of input as a simple title.

No data to store

Parameters
array$fieldOptionsA table of field options
Returns
self

Definition at line 1505 of file html.formsetup.class.php.

References type.

◆ setAsPassword()

FormSetupItem::setAsPassword ( )

Set type of input as a password with dolibarr password rules apply.

Hide entry on display.

Returns
self

Definition at line 1559 of file html.formsetup.class.php.

References type.

◆ setAsProduct()

FormSetupItem::setAsProduct ( )

Set type of input as product.

Returns
self

Definition at line 1468 of file html.formsetup.class.php.

References type.

◆ setAsSecureKey()

FormSetupItem::setAsSecureKey ( )

Set type of input as secure key.

Returns
self

Definition at line 1457 of file html.formsetup.class.php.

References type.

◆ setAsSelect()

FormSetupItem::setAsSelect ( $fieldOptions)

Set type of input as a simple title.

No data to store

Parameters
array$fieldOptionsA table of field options
Returns
self

Definition at line 1521 of file html.formsetup.class.php.

References type.

◆ setAsSelectBankAccount()

FormSetupItem::setAsSelectBankAccount ( )

Set type of input as a simple title.

No data to store

Returns
self

Definition at line 1547 of file html.formsetup.class.php.

References type.

◆ setAsSelectUser()

FormSetupItem::setAsSelectUser ( )

Set type of input as a simple title.

No data to store

Returns
self

Definition at line 1536 of file html.formsetup.class.php.

References type.

◆ setAsString()

FormSetupItem::setAsString ( )

Set type of input as string.

Returns
self

Definition at line 1379 of file html.formsetup.class.php.

References type.

◆ setAsTextarea()

FormSetupItem::setAsTextarea ( )

Set type of input as textarea.

Returns
self

Definition at line 1401 of file html.formsetup.class.php.

References type.

◆ setAsThirdpartyType()

FormSetupItem::setAsThirdpartyType ( )

Set type of input as thirdparty_type selector.

Returns
self

Definition at line 1435 of file html.formsetup.class.php.

References type.

◆ setAsTitle()

FormSetupItem::setAsTitle ( )

Set type of input as a simple title.

No data to store

Returns
self

Definition at line 1492 of file html.formsetup.class.php.

References type.

◆ setAsYesNo()

FormSetupItem::setAsYesNo ( )

Set type of input as Yes.

Returns
self

Definition at line 1446 of file html.formsetup.class.php.

References type.

◆ setErrors()

FormSetupItem::setErrors ( $errors)

Add error.

Parameters
array | string$errorsthe error text
Returns
null

Definition at line 1166 of file html.formsetup.class.php.

◆ setSaveCallBack()

FormSetupItem::setSaveCallBack ( callable $callBack)

Set an override function for saving data.

Parameters
callable$callBacka callable function
Returns
void

Definition at line 767 of file html.formsetup.class.php.

◆ setTypeFromTypeString()

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

Parameters
string$typePossible values based on old module builder setup : 'string', 'textarea', 'category:'.Categorie\TYPE_CUSTOMER', 'emailtemplate', 'thirdparty_type'
Deprecated
this setTypeFromTypeString came deprecated because it exists only for manage setup conversion
Returns
bool

Definition at line 1153 of file html.formsetup.class.php.

References type.

◆ setValueFromPost()

FormSetupItem::setValueFromPost ( )

Save const value based on htdocs/core/actions_setmoduleoptions.inc.php.

Returns
int -1 if KO, 0 nothing to do , 1 if OK

Definition at line 788 of file html.formsetup.class.php.

References GETPOST(), GETPOSTINT(), and type.

◆ setValueFromPostCallBack()

FormSetupItem::setValueFromPostCallBack ( callable $callBack)

Set an override function for get data from post.

Parameters
callable$callBacka callable function
Returns
void

Definition at line 778 of file html.formsetup.class.php.


The documentation for this class was generated from the following file: