Public Member Functions
	__construct ($form=null)

	_addClientSideValidation ($params)

	_getLayoutInfo ($params)

	_smartyFBVAutocompleteInput ($params, $smarty)

	_smartyFBVButton ($params, $smarty)

	_smartyFBVCheckbox ($params, $smarty)

	_smartyFBVCheckboxGroup ($params, $smarty)

	_smartyFBVFileInput ($params, $smarty)

	_smartyFBVHiddenInput ($params, $smarty)

	_smartyFBVInterestsInput ($params, $smarty)

	_smartyFBVKeywordInput ($params, $smarty)

	_smartyFBVRadioButton ($params, $smarty)

	_smartyFBVSelect ($params, $smarty)

	_smartyFBVSubLabel ($params, $smarty)

	_smartyFBVTextArea ($params, $smarty)

	_smartyFBVTextInput ($params, $smarty)

	getForm ()

	getStyles ()

	setForm ($form)

	smartyFBVElement ($params, $smarty, $content=null)

	smartyFBVFormArea ($params, $content, $smarty, &$repeat)

	smartyFBVFormButtons ($params, $smarty)

	smartyFBVFormSection ($params, $content, $smarty, &$repeat)

	smartyFieldLabel ($params, $smarty)

Data Fields
	$_fbvStyles

	$_form

Detailed Description

Definition at line 57 of file FormBuilderVocabulary.inc.php.

Constructor & Destructor Documentation

◆ __construct()

FormBuilderVocabulary::__construct ( $form = null )

Constructor.

Parameters

$form object Form associated with this object

Definition at line 68 of file FormBuilderVocabulary.inc.php.

Member Function Documentation

◆ _addClientSideValidation()

FormBuilderVocabulary::_addClientSideValidation ( $params )

Assign the appropriate class name to the element for client-side validation

Parameters

$params array return array

Definition at line 824 of file FormBuilderVocabulary.inc.php.

References getForm().

Referenced by smartyFBVElement().

◆ _getLayoutInfo()

FormBuilderVocabulary::_getLayoutInfo ( $params )

Cycle through layout parameters to add the appropriate classes to the element's parent container

Parameters

$params array

Returns: string

Definition at line 841 of file FormBuilderVocabulary.inc.php.

Referenced by smartyFBVElement(), and smartyFBVFormSection().

◆ _smartyFBVAutocompleteInput()

FormBuilderVocabulary::_smartyFBVAutocompleteInput	(	$params,
		$smarty
	)

Form Autocomplete text input. (actually two inputs, label and value) parameters: disabled (optional), name (optional - assigned value of 'id' by default)

Parameters

$params	array
$smarty	object

Definition at line 345 of file FormBuilderVocabulary.inc.php.

References _smartyFBVTextInput().

Referenced by smartyFBVElement().

◆ _smartyFBVButton()

FormBuilderVocabulary::_smartyFBVButton	(	$params,
		$smarty
	)

Form button. parameters: label (or value), disabled (optional), type (optional)

Parameters

$params	array
$smarty	object

Definition at line 315 of file FormBuilderVocabulary.inc.php.

Referenced by smartyFBVElement().

◆ _smartyFBVCheckbox()

FormBuilderVocabulary::_smartyFBVCheckbox	(	$params,
		$smarty
	)

Checkbox input control. parameters: label, disabled (optional), translate (optional), name (optional - value of 'id' by default)

Parameters

$params	array
$smarty	object

Definition at line 632 of file FormBuilderVocabulary.inc.php.

Referenced by smartyFBVElement().

◆ _smartyFBVCheckboxGroup()

FormBuilderVocabulary::_smartyFBVCheckboxGroup	(	$params,
		$smarty
	)

Form checkbox group control. parameters: from [array], selected [array index], defaultLabel (optional), defaultValue (optional), disabled (optional), translate (optional), name (optional - value of 'id' by default)

Parameters

$params	array
$smarty	object

Definition at line 595 of file FormBuilderVocabulary.inc.php.

Referenced by smartyFBVElement().

◆ _smartyFBVFileInput()

FormBuilderVocabulary::_smartyFBVFileInput	(	$params,
		$smarty
	)

File upload input. parameters: submit (optional - name of submit button to include), disabled (optional), name (optional - value of 'id' by default)

Parameters

$params	array
$smarty	object

Definition at line 699 of file FormBuilderVocabulary.inc.php.

References _smartyFBVSubLabel().

Referenced by smartyFBVElement().

◆ _smartyFBVHiddenInput()

FormBuilderVocabulary::_smartyFBVHiddenInput	(	$params,
		$smarty
	)

Hidden input element. parameters: value, id, name (optional - assigned value of 'id' by default), disabled (optional), multilingual (optional)

Parameters

$params	array
$smarty	object

Definition at line 515 of file FormBuilderVocabulary.inc.php.

Referenced by smartyFBVElement().

◆ _smartyFBVInterestsInput()

FormBuilderVocabulary::_smartyFBVInterestsInput	(	$params,
		$smarty
	)

Reviewing interests input. parameters: interests - current users's keywords (array)

Parameters

$params	array
$smarty	object

Definition at line 763 of file FormBuilderVocabulary.inc.php.

References _smartyFBVSubLabel().

Referenced by smartyFBVElement().

◆ _smartyFBVKeywordInput()

FormBuilderVocabulary::_smartyFBVKeywordInput	(	$params,
		$smarty
	)

Keyword input. parameters: available - all available keywords (for autosuggest); current - user's current keywords

Parameters

$params	array
$smarty	object

Definition at line 726 of file FormBuilderVocabulary.inc.php.

References _smartyFBVSubLabel().

Referenced by smartyFBVElement().

◆ _smartyFBVRadioButton()

FormBuilderVocabulary::_smartyFBVRadioButton	(	$params,
		$smarty
	)

Radio input control. parameters: label, disabled (optional), translate (optional), name (optional - value of 'id' by default)

Parameters

$params	array
$smarty	object

Definition at line 663 of file FormBuilderVocabulary.inc.php.

Referenced by smartyFBVElement().

◆ _smartyFBVSelect()

FormBuilderVocabulary::_smartyFBVSelect	(	$params,
		$smarty
	)

Form select control. parameters: from [array], selected [array index], defaultLabel (optional), defaultValue (optional), disabled (optional), translate (optional), name (optional - value of 'id' by default)

Parameters

$params	array
$smarty	object

Definition at line 545 of file FormBuilderVocabulary.inc.php.

References _smartyFBVSubLabel().

Referenced by smartyFBVElement().

◆ _smartyFBVSubLabel()

FormBuilderVocabulary::_smartyFBVSubLabel	(	$params,
		$smarty
	)

Custom Smarty function for labelling/highlighting of form fields.

Parameters

$params	array can contain 'name' (field name/ID), 'required' (required field), 'key' (localization key), 'label' (non-localized label string), 'suppressId' (boolean)
$smarty	Smarty

Definition at line 785 of file FormBuilderVocabulary.inc.php.

References getForm().

Referenced by _smartyFBVFileInput(), _smartyFBVInterestsInput(), _smartyFBVKeywordInput(), _smartyFBVSelect(), _smartyFBVTextArea(), and _smartyFBVTextInput().

◆ _smartyFBVTextArea()

FormBuilderVocabulary::_smartyFBVTextArea	(	$params,
		$smarty
	)

Form text area. parameters:

value: string for single language inputs, array (xx_YY => language_value) for multilingual
name: string (optional - assigned value based on ID by default)
disabled: boolean (default false)
multilingual: boolean (default false)
rich: false (default), true, or 'extended'
Parameters

$params array

$smarty object

Definition at line 449 of file FormBuilderVocabulary.inc.php.

References _smartyFBVSubLabel(), and getStyles().

Referenced by smartyFBVElement().

◆ _smartyFBVTextInput()

FormBuilderVocabulary::_smartyFBVTextInput	(	$params,
		$smarty
	)

Form text input. parameters: disabled (optional), name (optional - assigned value of 'id' by default), multilingual (optional)

Parameters

$params	array
$smarty	object

Definition at line 378 of file FormBuilderVocabulary.inc.php.

References _smartyFBVSubLabel().

Referenced by _smartyFBVAutocompleteInput(), and smartyFBVElement().

◆ getForm()

FormBuilderVocabulary::getForm ( )

Get the form

Returns: Object

Definition at line 92 of file FormBuilderVocabulary.inc.php.

References $_form.

Referenced by _addClientSideValidation(), _smartyFBVSubLabel(), smartyFBVFormSection(), and smartyFieldLabel().

◆ getStyles()

FormBuilderVocabulary::getStyles ( )

Get the form style constants

Returns: array

Definition at line 100 of file FormBuilderVocabulary.inc.php.

References $_fbvStyles.

Referenced by _smartyFBVTextArea().

◆ setForm()

FormBuilderVocabulary::setForm ( $form )

Set the form

Parameters

$form object

Definition at line 83 of file FormBuilderVocabulary.inc.php.

◆ smartyFBVElement()

FormBuilderVocabulary::smartyFBVElement	(	$params,
		$smarty,
		$content = `null`
	)

Base form element.

Parameters

$params	array
$smarty	object-

Definition at line 227 of file FormBuilderVocabulary.inc.php.

References _addClientSideValidation(), _getLayoutInfo(), _smartyFBVAutocompleteInput(), _smartyFBVButton(), _smartyFBVCheckbox(), _smartyFBVCheckboxGroup(), _smartyFBVFileInput(), _smartyFBVHiddenInput(), _smartyFBVInterestsInput(), _smartyFBVKeywordInput(), _smartyFBVRadioButton(), _smartyFBVSelect(), _smartyFBVTextArea(), _smartyFBVTextInput(), and strtolower_codesafe().

◆ smartyFBVFormArea()

FormBuilderVocabulary::smartyFBVFormArea	(		$params,
			$content,
			$smarty,
		&	$repeat
	)

A form area that contains form sections.

Parameters

$params	array
$content	string
$smarty	object
$repeat

Definition at line 115 of file FormBuilderVocabulary.inc.php.

◆ smartyFBVFormButtons()

FormBuilderVocabulary::smartyFBVFormButtons	(	$params,
		$smarty
	)

Submit and (optional) cancel button for a form.

Parameters

$params	array
$smarty	object
$repeat

Definition at line 205 of file FormBuilderVocabulary.inc.php.

◆ smartyFBVFormSection()

FormBuilderVocabulary::smartyFBVFormSection	(		$params,
			$content,
			$smarty,
		&	$repeat
	)

A form section that contains controls in a variety of layout possibilities.

Parameters

$params	array
$content	string
$smarty	object
$repeat

Definition at line 137 of file FormBuilderVocabulary.inc.php.

References _getLayoutInfo(), and getForm().

◆ smartyFieldLabel()

FormBuilderVocabulary::smartyFieldLabel	(	$params,
		$smarty
	)

Custom Smarty function for labelling/highlighting of form fields.

Parameters

$params	array can contain 'name' (field name/ID), 'required' (required field), 'key' (localization key), 'label' (non-localized label string), 'suppressId' (boolean)
$smarty	Smarty

Definition at line 867 of file FormBuilderVocabulary.inc.php.

References getForm().

Field Documentation

◆ $_fbvStyles

FormBuilderVocabulary::$_fbvStyles

Styles organized by parameter name

Definition at line 62 of file FormBuilderVocabulary.inc.php.

Referenced by getStyles().

◆ $_form

FormBuilderVocabulary::$_form

Form associated with this object, if any. Will inform smarty which forms to label as required

Definition at line 59 of file FormBuilderVocabulary.inc.php.

Referenced by getForm().

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

FormBuilderVocabulary.inc.php

Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _addClientSideValidation()

◆ _getLayoutInfo()

◆ _smartyFBVAutocompleteInput()

◆ _smartyFBVButton()

◆ _smartyFBVCheckbox()

◆ _smartyFBVCheckboxGroup()

◆ _smartyFBVFileInput()

◆ _smartyFBVHiddenInput()

◆ _smartyFBVInterestsInput()

◆ _smartyFBVKeywordInput()

◆ _smartyFBVRadioButton()

◆ _smartyFBVSelect()

◆ _smartyFBVSubLabel()

◆ _smartyFBVTextArea()

◆ _smartyFBVTextInput()

◆ getForm()

◆ getStyles()

◆ setForm()

◆ smartyFBVElement()

◆ smartyFBVFormArea()

◆ smartyFBVFormButtons()

◆ smartyFBVFormSection()

◆ smartyFieldLabel()

Field Documentation

◆ $_fbvStyles

◆ $_form