FormSetup Class Reference

This class help you create setup render. More...

Public Member Functions
	__construct ($db, $outputLangs=false)
	Constructor. More...
	generateOutput ($editMode=false)
	generateOutput More...
	generateTableOutput ($editMode=false)
	generateTableOutput More...
	saveConfFromPost ($noMessageInUpdate=false)
	saveConfFromPost More...
	generateLineOutput ($item, $editMode=false)
	generateLineOutput More...
	addItemsFromParamsArray ($params)
	Method used to test module builder convertion to this form usage. More...
	addItemFromParams ($confKey, $params)
	From old Method was used to test module builder convertion to this form usage. More...
	exportItemsAsParamsArray ()
	Used to export param array for /core/actions_setmoduleoptions.inc.php template Method exists only for manage setup convertion. More...
	reloadConfs ()
	Reload for each item default conf note: this will override custom configuration. More...
	newItem ($confKey, $targetItemKey=false, $insertAfterTarget=false)
	Create a new item the tagret is useful with hooks : that allow externals modules to add setup items on good place. More...
	sortingItems ()
	Sort items according to rank. More...
	getCurentItemMaxRank ($cache=true)
	getCurentItemMaxRank More...
	setItemMaxRank ($rank)
	set new max rank if needed More...
	getLineRank ($itemKey)
	get item position rank from item key More...
	itemSort (FormSetupItem $a, FormSetupItem $b)
	uasort callback function to Sort params items More...

Static Public Member Functions
static	generateAttributesStringFromArray ($attributes)
	Generate an attributes string form an input array. More...

Detailed Description

This class help you create setup render.

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

Constructor & Destructor Documentation

__construct()

FormSetup::__construct	(		$db,
			$outputLangs = false
	)

Constructor.

Parameters

DoliDB	$db	Database handler
Translate	$outputLangs	if needed can use another lang

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

Member Function Documentation

addItemFromParams()

FormSetup::addItemFromParams	(		$confKey,
			$params
	)

From old Method was used to test module builder convertion to this form usage.

Parameters

string	$confKey	the conf name to store
array	$params	an array of params from old modulBuilder params

Returns

bool

@scrutinizer ignore-deprecated

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

addItemsFromParamsArray()

FormSetup::addItemsFromParamsArray

(

$params

)

Method used to test module builder convertion to this form usage.

Parameters

array

$params

an array of arrays of params from old modulBuilder params

Returns

null

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

exportItemsAsParamsArray()

FormSetup::exportItemsAsParamsArray

(

)

Used to export param array for /core/actions_setmoduleoptions.inc.php template Method exists only for manage setup convertion.

Returns

array $arrayofparameters for /core/actions_setmoduleoptions.inc.php

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

generateAttributesStringFromArray()

static FormSetup::generateAttributesStringFromArray (   $attributes )

static

Generate an attributes string form an input array.

Parameters

array

$attributes

an array of attributes keys and values,

Returns

string attribute string

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

generateLineOutput()

FormSetup::generateLineOutput	(		$item,
			$editMode = false
	)

generateLineOutput

Parameters

FormSetupItem	$item	the setup item
bool	$editMode	Display as edit mod

Returns

string the html output for an setup item

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

generateOutput()

FormSetup::generateOutput

(

$editMode = false

)

generateOutput

Parameters

bool

$editMode

true will display output on edit mod

Returns

string html output

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

generateTableOutput()

FormSetup::generateTableOutput

(

$editMode = false

)

generateTableOutput

Parameters

bool

$editMode

true will display output on edit mod

Returns

string html output

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

getCurentItemMaxRank()

FormSetup::getCurentItemMaxRank

(

$cache = true

)

getCurentItemMaxRank

Parameters

bool

$cache

To use cache or not

Returns

int

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

getLineRank()

FormSetup::getLineRank

(

$itemKey

)

get item position rank from item key

Parameters

string

$itemKey

the item key

Returns

int rank on success and -1 on error

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

itemSort()

FormSetup::itemSort	(	FormSetupItem	$a,
		FormSetupItem	$b
	)

uasort callback function to Sort params items

Parameters

FormSetupItem	$a	formSetup item
FormSetupItem	$b	formSetup item

Returns

int Return compare result

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

newItem()

FormSetup::newItem	(		$confKey,
			$targetItemKey = false,
			$insertAfterTarget = false
	)

Create a new item the tagret is useful with hooks : that allow externals modules to add setup items on good place.

Parameters

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 ?

Returns

FormSetupItem the new setup item created

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

reloadConfs()

FormSetup::reloadConfs

(

)

Reload for each item default conf note: this will override custom configuration.

Returns

bool

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

saveConfFromPost()

FormSetup::saveConfFromPost

(

$noMessageInUpdate = false

)

saveConfFromPost

Parameters

bool

$noMessageInUpdate

display event message on errors and success

Returns

int -1 if KO, 1 if OK

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

setItemMaxRank()

FormSetup::setItemMaxRank

(

$rank

)

set new max rank if needed

Parameters

int

$rank

the item rank

Returns

int|void new max rank

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

sortingItems()

FormSetup::sortingItems

(

)

Sort items according to rank.

Returns

bool

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

---

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

• htdocs/core/class/html.formsetup.class.php