Public Member Functions | |
| getConfig () | |
 Public Member Functions inherited from PKP\components\forms\Field | |
| __construct ($name, $args=array()) | |
| getEmptyValue () | |
| validate () | |
Data Fields | |
| $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 19 of file FieldBaseAutosuggest.inc.php.
Member Function Documentation
◆ getConfig()
| PKP\components\forms\FieldBaseAutosuggest::getConfig | ( | ) |
Get a configuration object representing this field to be passed to the UI Library
- Returns
- array
Reimplemented from PKP\components\forms\Field.
Reimplemented in PKP\components\forms\FieldControlledVocab.
Definition at line 50 of file FieldBaseAutosuggest.inc.php.
References PKP\components\forms\FieldBaseAutosuggest\$apiUrl, PKP\components\forms\FieldBaseAutosuggest\$getParams, PKP\components\forms\FieldBaseAutosuggest\$initialPosition, and PKP\components\forms\FieldBaseAutosuggest\$selected.
Field Documentation
◆ $apiUrl
| string FieldBaseAutosuggest::$apiUrl |
A URL to retrieve suggestions.
Definition at line 27 of file FieldBaseAutosuggest.inc.php.
Referenced by PKP\components\forms\FieldBaseAutosuggest\getConfig().
◆ $component
| PKP\components\forms\FieldBaseAutosuggest::$component = 'field-base-autosuggest' |
Which UI Library component this field represents
Definition at line 21 of file FieldBaseAutosuggest.inc.php.
◆ $getParams
| array FieldBaseAutosuggest::$getParams = [] |
Query params when getting suggestions.
Definition at line 33 of file FieldBaseAutosuggest.inc.php.
Referenced by PKP\components\forms\FieldBaseAutosuggest\getConfig().
◆ $initialPosition
| string FieldBaseAutosuggest::$initialPosition = AUTOSUGGEST_POSITION_INLINE |
Displayed in the text box or below the input. One of the AUTOSUGGEST_POSITION_* constants.
Definition at line 39 of file FieldBaseAutosuggest.inc.php.
Referenced by PKP\components\forms\FieldBaseAutosuggest\getConfig().
◆ $selected
| array FieldBaseAutosuggest::$selected = [] |
List of selected items.
Definition at line 45 of file FieldBaseAutosuggest.inc.php.
Referenced by PKP\components\forms\FieldBaseAutosuggest\getConfig().
The documentation for this class was generated from the following file:
