BxBaseFormView Class Reference

Inheritance diagram for BxBaseFormView:

Public Member Functions
	__construct ($aInfo, $oTemplate)
	getCode ($bDynamicMode=false)
	genForm ()
	genRows ()
	genRow (&$aInput)
	genViewRow (&$aInput)
	genViewRowWrapped (&$aInput)
	genViewRowValue (&$aInput)
	genRowStandard (&$aInput, $isOneLine=false)
	genRowCustom (&$aInput, $sCustomMethod)
	genRowBlockHeader (&$aInput)
	genInput (&$aInput)
	getInputId (&$aInput)
	genInputStandard (&$aInput)
	genInputSwitcher (&$aInput)
	genInputButton (&$aInput)
	genInputTextarea (&$aInput)
	genInputSelectBox (&$aInput, $sInfo='', $sError='')
	genInputFile (&$aInput)
	genInputFiles (&$aInput, $sInfo='', $sError='')
	genInputSelect (&$aInput)
	genInputSelectRgb (&$aInput)
	genInputSelectMultiple (&$aInput)
	genInputCheckboxSet (&$aInput)
	genInputRadioSet (&$aInput)
	genLabel (&$aInput)
Public Member Functions inherited from BxDolForm
	isFieldExist ($sName, $bCheckAllFields=false)
	addMarkers ($a)

Protected Attributes
	$bEnableErrorIcon = true
	$sCode
	$_sCodeAdd = ''
	$_isSectionOpened = false
	$_sDivider = '<span class="bx-def-margin-left"></span>'
	$_sDividerAlt = '<br />'
	$_bDynamicMode = false
	$_bAjaxMode = false
	$_bAbsoluteActionUrl = false
	$_bViewMode = false
	$_bShowEmptySections = false
	$_sSectionClose = 'getCloseSection'
	$_sSectionOpen = 'getOpenSection'
	$_aJs = array()
	$_aCss = array()

Additional Inherited Members
Static Public Member Functions inherited from BxDolForm
static	getObjectInstance ($sObject, $sDisplayName, $oTemplate=false, $sParam='')
static	getDataItems ($sKey, $isUseForSet=false, $sUseValues=BX_DATA_VALUES_DEFAULT)
static	isVisible ($aInput)
Protected Member Functions inherited from BxDolForm
	_replaceMarkers ($a)

Constructor & Destructor Documentation

__construct()

BxBaseFormView::__construct	(		$aInfo,
			$oTemplate
	)

Constructor

Parameters

array

$aInfo

Form contents

$aInfo['params'] = array( 'remove_form' => true|false, );

Returns

BxBaseFormView

Member Function Documentation

genForm()

BxBaseFormView::genForm

(

)

Generate the whole form

Returns

string

genInput()

BxBaseFormView::genInput

(

&

$aInput

)

Generate HTML Input Element

Parameters

array

$aInput

Returns

string Output HTML Code

genInputButton()

BxBaseFormView::genInputButton

(

&

$aInput

)

Generate Button Input Element

Parameters

array

$aInput

Returns

string

genInputCheckboxSet()

BxBaseFormView::genInputCheckboxSet

(

&

$aInput

)

Generate Checkbox Set Element

Parameters

array

$aInput

Returns

string

genInputFile()

BxBaseFormView::genInputFile

(

&

$aInput

)

Generate Browse File Element

Parameters

array

$aInput

Returns

string

genInputFiles()

BxBaseFormView::genInputFiles	(	&	$aInput,
			$sInfo = '',
			$sError = ''
	)

Generate Select Box Element

Parameters

array

$aInput

Returns

string

genInputRadioSet()

BxBaseFormView::genInputRadioSet

(

&

$aInput

)

Generate Radiobuttons Set Element

Parameters

array

$aInput

Returns

string

genInputSelect()

BxBaseFormView::genInputSelect

(

&

$aInput

)

Generate Select Element

Parameters

array

$aInput

Returns

string

genInputSelectBox()

BxBaseFormView::genInputSelectBox	(	&	$aInput,
			$sInfo = '',
			$sError = ''
	)

Generate Select Box Element

Parameters

array

$aInput

Returns

string

genInputSelectMultiple()

BxBaseFormView::genInputSelectMultiple

(

&

$aInput

)

Generate Multiple Select Element

Parameters

array

$aInput

Returns

string

genInputSelectRgb()

BxBaseFormView::genInputSelectRgb

(

&

$aInput

)

Generate Select RGB Element

Parameters

array

$aInput

Returns

string

genInputStandard()

BxBaseFormView::genInputStandard

(

&

$aInput

)

Generate standard Input Element

Parameters

array

$aInput

Returns

string

genInputSwitcher()

BxBaseFormView::genInputSwitcher

(

&

$aInput

)

Generate Switcher Input Element (based on checkbox)

Parameters

array

$aInput

Returns

string

genInputTextarea()

BxBaseFormView::genInputTextarea

(

&

$aInput

)

Generate Textarea Element

Parameters

array

$aInput

Returns

string

genLabel()

BxBaseFormView::genLabel

(

&

$aInput

)

Generate Label Element

Parameters

string

$aInput

input array

Returns

string HTML code

genRow()

BxBaseFormView::genRow

(

&

$aInput

)

Generate single Table Row

Parameters

array

$aInput

Returns

string

genRowBlockHeader()

BxBaseFormView::genRowBlockHeader

(

&

$aInput

)

Generate Block Headers row

Parameters

array

$aInput

Returns

string

genRowCustom()

BxBaseFormView::genRowCustom	(	&	$aInput,
			$sCustomMethod
	)

Generate custom row

Parameters

array	$aInput
string	$sCustomMethod	custom method to generate code for input

Returns

string

genRows()

BxBaseFormView::genRows

(

)

Generate Table HTML code

Returns

string

genRowStandard()

BxBaseFormView::genRowStandard	(	&	$aInput,
			$isOneLine = false
	)

Generate standard row

Parameters

array

$aInput

Returns

string

genViewRow()

BxBaseFormView::genViewRow

(

&

$aInput

)

Generate single Table Row for view mode

Parameters

array

$aInput

Returns

string

genViewRowValue()

BxBaseFormView::genViewRowValue

(

&

$aInput

)

Generate value for view mode row

Parameters

array

$aInput

Returns

string

genViewRowWrapped()

BxBaseFormView::genViewRowWrapped

(

&

$aInput

)

Generate complete wrapped row for view mode form

Parameters

array

$aInput

Returns

string

getCode()

BxBaseFormView::getCode

(

$bDynamicMode = false

)

Return Form code

Parameters

$bDynamicMode

- set it to true if form is added via JS/AJAX call, for example form in AJAX popup.

Returns

string

getInputId()

BxBaseFormView::getInputId

(

&

$aInput

)

Generate new Input Element id

Parameters

array

$aInput

Returns

string

Member Data Documentation

$_aCss

BxBaseFormView::$_aCss = array()

protected

CSS files list for form

$_aJs

BxBaseFormView::$_aJs = array()

protected

JS files list for form

$_bAbsoluteActionUrl

BxBaseFormView::$_bAbsoluteActionUrl = false

protected

Use absolute Action URL which is needed in Ajax Mode.

$_bAjaxMode

BxBaseFormView::$_bAjaxMode = false

protected

Form is submitted dynamically (using Ajax Submit).

$_bDynamicMode

BxBaseFormView::$_bDynamicMode = false

protected

Form is added dynamically.

$_bShowEmptySections

BxBaseFormView::$_bShowEmptySections = false

protected

Show or not sections which have no fileds

$_bViewMode

BxBaseFormView::$_bViewMode = false

protected

Form is displayed in view mode.

$_isSectionOpened

BxBaseFormView::$_isSectionOpened = false

protected

for internal use only

$_sCodeAdd

BxBaseFormView::$_sCodeAdd = ''

protected

Code which will be added to the beginning of the form. For example, hidden inputs. For internal use only

$_sDivider

BxBaseFormView::$_sDivider = '<span class="bx-def-margin-left"></span>'

protected

Default divider for several inputs

$_sDividerAlt

BxBaseFormView::$_sDividerAlt = '<br />'

protected

Alternative divider for several inputs

$_sSectionClose

BxBaseFormView::$_sSectionClose = 'getCloseSection'

protected

Function name for generation close form section HTML.

$_sSectionOpen

BxBaseFormView::$_sSectionOpen = 'getOpenSection'

protected

Function name for generation open form section HTML.

$bEnableErrorIcon

BxBaseFormView::$bEnableErrorIcon = true

protected

Enable or disable error message displaying

$sCode

BxBaseFormView::$sCode

protected

HTML Code of this form

---

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

• template/scripts/BxBaseFormView.php