Public Member Functions | |
| getConfig () | |
 Public Member Functions inherited from PKP\components\forms\Field | |
| __construct ($name, $args=array()) | |
| getEmptyValue () | |
| validate () | |
Data Fields | |
| $component = 'field-metadata-setting' | |
| $disabledValue = METADATA_DISABLE | |
| $enabledOnlyValue = METADATA_ENABLE | |
| $submissionOptions = [] | |
| Data Fields inherited from PKP\components\forms\FieldOptions | |
| $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 16 of file FieldMetadataSetting.inc.php.
Member Function Documentation
◆ getConfig()
| PKP\components\forms\FieldMetadataSetting::getConfig | ( | ) |
Get a configuration object representing this field to be passed to the UI Library
- Returns
- array
Reimplemented from PKP\components\forms\FieldOptions.
Definition at line 44 of file FieldMetadataSetting.inc.php.
References PKP\components\forms\FieldMetadataSetting\$disabledValue, PKP\components\forms\FieldMetadataSetting\$enabledOnlyValue, and PKP\components\forms\FieldMetadataSetting\$submissionOptions.
Field Documentation
◆ $component
| PKP\components\forms\FieldMetadataSetting::$component = 'field-metadata-setting' |
Which UI Library component this field represents
Definition at line 18 of file FieldMetadataSetting.inc.php.
◆ $disabledValue
| integer FieldMetadataSetting::$disabledValue = METADATA_DISABLE |
What is the value that represents metadata that is disabled
Definition at line 24 of file FieldMetadataSetting.inc.php.
Referenced by PKP\components\forms\FieldMetadataSetting\getConfig().
◆ $enabledOnlyValue
| integer FieldMetadataSetting::$enabledOnlyValue = METADATA_ENABLE |
What is the value that represents metadata that is enabled, but which is not requested or required during submission?
Definition at line 33 of file FieldMetadataSetting.inc.php.
Referenced by PKP\components\forms\FieldMetadataSetting\getConfig().
◆ $submissionOptions
| array FieldMetadataSetting::$submissionOptions = [] |
The options for what to request/require from the author during submission
Definition at line 39 of file FieldMetadataSetting.inc.php.
Referenced by PKP\components\forms\FieldMetadataSetting\getConfig().
The documentation for this class was generated from the following file:
