This class help to create item for class formSetup. More...

Public Member Functions
	__construct ($confKey)
	Constructor. More...

	loadValueFromConf ()
	load conf value from databases More...

	reloadValueFromConf ()
	reload conf value from databases is an aliase of loadValueFromConf More...

	saveConfValue ()
	Save const value based on htdocs/core/actions_setmoduleoptions.inc.php. More...

	setSaveCallBack (callable $callBack)
	Set an override function for saving data. More...

	setValueFromPostCallBack (callable $callBack)
	Set an override function for get data from post. More...

	setValueFromPost ()
	Save const value based on htdocs/core/actions_setmoduleoptions.inc.php. More...

	getHelpText ()
	Get help text or generate it. More...

	getNameText ()
	Get field name text or generate it. More...

	generateInputField ()
	generate input field More...

	generateInputFieldText ()
	generatec default input field More...

	generateInputFieldTextarea ()
	generate input field for textarea More...

	generateInputFieldHtml ()
	generate input field for html More...

	generateInputFieldCategories ()
	generate input field for categories More...

	generateInputFieldEmailTemplate ()
	generate input field for email template selector More...

	generateInputFieldSecureKey ()
	generate input field for secure key More...

	generateInputFieldMultiSelect ()

	generateInputFieldSelect ()

	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 More...

	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 More...

	setErrors ($errors)
	Add error. More...

	generateOutputField ()

	generateOutputFieldMultiSelect ()

	generateOutputFieldColor ()

	generateInputFieldColor ()

	generateOutputFieldSelect ()

	setAsString ()
	Set type of input as string. More...

	setAsColor ()
	Set type of input as color. More...

	setAsTextarea ()
	Set type of input as textarea. More...

	setAsHtml ()
	Set type of input as html editor. More...

	setAsEmailTemplate ($templateType)
	Set type of input as emailtemplate selector. More...

	setAsThirdpartyType ()
	Set type of input as thirdparty_type selector. More...

	setAsYesNo ()
	Set type of input as Yes. More...

	setAsSecureKey ()
	Set type of input as secure key. More...

	setAsProduct ()
	Set type of input as product. More...

	setAsCategory ($catType)
	Set type of input as a category selector TODO add default value. More...

	setAsTitle ()
	Set type of input as a simple title no data to store. More...

	setAsMultiSelect ($fieldOptions)
	Set type of input as a simple title no data to store. More...

	setAsSelect ($fieldOptions)
	Set type of input as a simple title no data to store. More...

Public Attributes
	$nameText = false

	$helpText = ''

	$fieldValue

	$defaultFieldValue = null

	$rank = 0

	$saveCallBack

	$setValueFromPostCallBack

Detailed Description

This class help to create item for class formSetup.

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

Constructor & Destructor Documentation

◆ __construct()

FormSetupItem::__construct ( $confKey )

Constructor.

Parameters

string $confKey the conf key used in database

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

Member Function Documentation

◆ generateInputField()

FormSetupItem::generateInputField ( )

generate input field

Returns: bool|string

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

◆ generateInputFieldCategories()

FormSetupItem::generateInputFieldCategories ( )

generate input field for categories

Returns: string

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

◆ generateInputFieldColor()

FormSetupItem::generateInputFieldColor ( )

Returns: string

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

◆ generateInputFieldEmailTemplate()

FormSetupItem::generateInputFieldEmailTemplate ( )

generate input field for email template selector

Returns: string

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

◆ generateInputFieldHtml()

FormSetupItem::generateInputFieldHtml ( )

generate input field for html

Returns: string

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

◆ generateInputFieldMultiSelect()

FormSetupItem::generateInputFieldMultiSelect ( )

Returns: string

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

◆ generateInputFieldSecureKey()

FormSetupItem::generateInputFieldSecureKey ( )

generate input field for secure key

Returns: string

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

◆ generateInputFieldSelect()

FormSetupItem::generateInputFieldSelect ( )

Returns: string

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

◆ generateInputFieldText()

FormSetupItem::generateInputFieldText ( )

generatec default input field

Returns: string

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

◆ generateInputFieldTextarea()

FormSetupItem::generateInputFieldTextarea ( )

generate input field for textarea

Returns: string

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

◆ generateOutputField()

FormSetupItem::generateOutputField ( )

Returns: bool|string Generate the output html for this item

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

◆ generateOutputFieldColor()

FormSetupItem::generateOutputFieldColor ( )

Returns: string

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

◆ generateOutputFieldMultiSelect()

FormSetupItem::generateOutputFieldMultiSelect ( )

Returns: string

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

◆ generateOutputFieldSelect()

FormSetupItem::generateOutputFieldSelect ( )

Returns: string

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

◆ getHelpText()

FormSetupItem::getHelpText ( )

Get help text or generate it.

Returns: int|string

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

◆ getNameText()

FormSetupItem::getNameText ( )

Get field name text or generate it.

Returns: false|int|string

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

◆ 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 998 of file html.formsetup.class.php.

◆ loadValueFromConf()

FormSetupItem::loadValueFromConf ( )

load conf value from databases

Returns: bool

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

◆ reloadValueFromConf()

FormSetupItem::reloadValueFromConf ( )

reload conf value from databases is an aliase of loadValueFromConf

Deprecated:

Returns: bool

Definition at line 677 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 687 of file html.formsetup.class.php.

◆ setAsCategory()

FormSetupItem::setAsCategory ( $catType )

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

Parameters

int $catType Type of category ('customer', 'supplier', 'contact', 'product', 'member'). Old mode (0, 1, 2, ...) is deprecated.

Returns: self

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

References type.

◆ setAsColor()

FormSetupItem::setAsColor ( )

Set type of input as color.

Returns: self

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

References type.

◆ setAsEmailTemplate()

FormSetupItem::setAsEmailTemplate ( $templateType )

Set type of input as emailtemplate selector.

Parameters

string $templateType email template type

Returns: self

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

References type.

◆ setAsHtml()

FormSetupItem::setAsHtml ( )

Set type of input as html editor.

Returns: self

Definition at line 1217 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 $fieldOptions A table of field options

Returns: self

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

References type.

◆ setAsProduct()

FormSetupItem::setAsProduct ( )

Set type of input as product.

Returns: self

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

References type.

◆ setAsSecureKey()

FormSetupItem::setAsSecureKey ( )

Set type of input as secure key.

Returns: self

Definition at line 1258 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 $fieldOptions A table of field options

Returns: self

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

References type.

◆ setAsString()

FormSetupItem::setAsString ( )

Set type of input as string.

Returns: self

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

References type.

◆ setAsTextarea()

FormSetupItem::setAsTextarea ( )

Set type of input as textarea.

Returns: self

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

References type.

◆ setAsThirdpartyType()

FormSetupItem::setAsThirdpartyType ( )

Set type of input as thirdparty_type selector.

Returns: self

Definition at line 1238 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 1291 of file html.formsetup.class.php.

References type.

◆ setAsYesNo()

FormSetupItem::setAsYesNo ( )

Set type of input as Yes.

Returns: self

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

References type.

◆ setErrors()

FormSetupItem::setErrors ( $errors )

Add error.

Parameters

array | string $errors the error text

Returns: null

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

◆ setSaveCallBack()

FormSetupItem::setSaveCallBack ( callable $callBack )

Set an override function for saving data.

Parameters

callable $callBack a callable function

Returns: void

Definition at line 723 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 $type possible values based on old module builder setup : 'string', 'textarea', 'category:'.Categorie::TYPE_CUSTOMER', 'emailtemplate', 'thirdparty_type'

Deprecated:: yes this setTypeFromTypeString came deprecated because it exists only for manage setup convertion

Returns: bool

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

◆ 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 742 of file html.formsetup.class.php.

References GETPOST(), and type.

◆ setValueFromPostCallBack()

FormSetupItem::setValueFromPostCallBack ( callable $callBack )

Set an override function for get data from post.

Parameters

callable $callBack a callable function

Returns: void

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

Member Data Documentation

◆ $defaultFieldValue

string FormSetupItem::$defaultFieldValue = null

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

◆ $fieldValue

string FormSetupItem::$fieldValue

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

◆ $helpText

string FormSetupItem::$helpText = ''

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

◆ $nameText

string false FormSetupItem::$nameText = false

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

◆ $rank

int FormSetupItem::$rank = 0

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

◆ $saveCallBack

callable FormSetupItem::$saveCallBack

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

◆ $setValueFromPostCallBack

callable FormSetupItem::$setValueFromPostCallBack

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

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

dolibarr_17.0/htdocs/core/class/html.formsetup.class.php

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ generateInputField()

◆ generateInputFieldCategories()

◆ generateInputFieldColor()

◆ generateInputFieldEmailTemplate()

◆ generateInputFieldHtml()

◆ generateInputFieldMultiSelect()

◆ generateInputFieldSecureKey()

◆ generateInputFieldSelect()

◆ generateInputFieldText()

◆ generateInputFieldTextarea()

◆ generateOutputField()

◆ generateOutputFieldColor()

◆ generateOutputFieldMultiSelect()

◆ generateOutputFieldSelect()

◆ getHelpText()

◆ getNameText()

◆ getType()

◆ loadValueFromConf()

◆ reloadValueFromConf()

◆ saveConfValue()

◆ setAsCategory()

◆ setAsColor()

◆ setAsEmailTemplate()

◆ setAsHtml()

◆ setAsMultiSelect()

◆ setAsProduct()

◆ setAsSecureKey()

◆ setAsSelect()

◆ setAsString()

◆ setAsTextarea()

◆ setAsThirdpartyType()

◆ setAsTitle()

◆ setAsYesNo()

◆ setErrors()

◆ setSaveCallBack()

◆ setTypeFromTypeString()

◆ setValueFromPost()

◆ setValueFromPostCallBack()

Member Data Documentation

◆ $defaultFieldValue

◆ $fieldValue

◆ $helpText

◆ $nameText

◆ $rank

◆ $saveCallBack

◆ $setValueFromPostCallBack