Public Member Functions | |
| getConfig () | |
 Public Member Functions inherited from PKP\components\forms\Field | |
| __construct ($name, $args=array()) | |
| getEmptyValue () | |
| validate () | |
Data Fields | |
| $component = 'field-options' | |
| $isOrderable = false | |
| $options = [] | |
| $type = 'checkbox' | |
| 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 15 of file FieldOptions.inc.php.
Member Function Documentation
◆ getConfig()
| PKP\components\forms\FieldOptions::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\FieldMetadataSetting, and PKP\components\forms\FieldShowEnsuringLink.
Definition at line 40 of file FieldOptions.inc.php.
References PKP\components\forms\FieldOptions\$isOrderable, PKP\components\forms\FieldOptions\$options, and PKP\components\forms\FieldOptions\$type.
Field Documentation
◆ $component
| PKP\components\forms\FieldOptions::$component = 'field-options' |
Which UI Library component this field represents
Definition at line 17 of file FieldOptions.inc.php.
◆ $isOrderable
| boolean FieldOptions::$isOrderable = false |
Should the user be able to re-order the options?
Definition at line 29 of file FieldOptions.inc.php.
Referenced by PKP\components\forms\FieldOptions\getConfig().
◆ $options
| array FieldOptions::$options = [] |
The options which can be selected
Definition at line 35 of file FieldOptions.inc.php.
Referenced by PKP\components\forms\FieldOptions\getConfig().
◆ $type
| string FieldOptions::$type = 'checkbox' |
Use a checkbox or radio button input type
Definition at line 23 of file FieldOptions.inc.php.
Referenced by PKP\components\forms\FieldOptions\getConfig().
The documentation for this class was generated from the following file:
