PKP\components\forms\FieldControlledVocab Class Reference

Inheritance diagram for PKP\components\forms\FieldControlledVocab:

Public Member Functions
	getConfig ()
	mapSelected ($value)
Public Member Functions inherited from PKP\components\forms\Field
	__construct ($name, $args=array())
	getEmptyValue ()
	validate ()

Data Fields
	$component = 'field-controlled-vocab'
	$locales = []
Data Fields inherited from PKP\components\forms\FieldBaseAutosuggest
	$apiUrl
	$component = 'field-base-autosuggest'
	$getParams = []
	$initialPosition = AUTOSUGGEST_POSITION_INLINE
	$selected = []
Data Fields inherited from PKP\components\forms\Field
	$component
	$default
	$description
	$groupId
	$helpSection
	$helpTopic
	$isMultilingual = false
	$isRequired = false
	$label = ''
	$name
	$showWhen
	$tooltip
	$value

Detailed Description

Definition at line 18 of file FieldControlledVocab.inc.php.

Member Function Documentation

getConfig()

PKP\components\forms\FieldControlledVocab::getConfig

(

)

Get a configuration object representing this field to be passed to the UI Library

Returns

array

Reimplemented from PKP\components\forms\FieldBaseAutosuggest.

Definition at line 28 of file FieldControlledVocab.inc.php.

mapSelected()

PKP\components\forms\FieldControlledVocab::mapSelected

(

$value

)

Map the selected values to the format expected by an autosuggest field

Parameters

string

value

Returns

array

Definition at line 54 of file FieldControlledVocab.inc.php.

References PKP\components\forms\Field\$value.

Field Documentation

$component

PKP\components\forms\FieldControlledVocab::$component = 'field-controlled-vocab'

Which UI Library component this field represents

Definition at line 20 of file FieldControlledVocab.inc.php.

$locales

PKP\components\forms\FieldControlledVocab::$locales = []

Parameters

array

Key/value list of languages this field should support. Key = locale code. Value = locale name

Definition at line 23 of file FieldControlledVocab.inc.php.

---

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

• FieldControlledVocab.inc.php