Public Member Functions | |
| getConfig () | |
 Public Member Functions inherited from PKP\components\forms\Field | |
| __construct ($name, $args=array()) | |
| getEmptyValue () | |
| validate () | |
Data Fields | |
| $component = 'field-text' | |
| $inputType = 'text' | |
| $optIntoEdit = false | |
| $optIntoEditLabel = '' | |
| $prefix = '' | |
| $size = 'normal' | |
| 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 FieldText.inc.php.
Member Function Documentation
◆ getConfig()
| PKP\components\forms\FieldText::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 Plugins\Generic\URN\FieldUrn.
Definition at line 52 of file FieldText.inc.php.
References PKP\components\forms\FieldText\$inputType, PKP\components\forms\FieldText\$optIntoEdit, PKP\components\forms\FieldText\$optIntoEditLabel, PKP\components\forms\FieldText\$prefix, and PKP\components\forms\FieldText\$size.
Field Documentation
◆ $component
| PKP\components\forms\FieldText::$component = 'field-text' |
Which UI Library component this field represents
Definition at line 17 of file FieldText.inc.php.
◆ $inputType
| string FieldText::$inputType = 'text' |
What should the <input type=""> be?
Definition at line 23 of file FieldText.inc.php.
Referenced by PKP\components\forms\FieldText\getConfig().
◆ $optIntoEdit
| boolean FieldText::$optIntoEdit = false |
Whether the user should have to click a button to edit the field
Definition at line 29 of file FieldText.inc.php.
Referenced by PKP\components\forms\FieldText\getConfig().
◆ $optIntoEditLabel
| string FieldText::$optIntoEditLabel = '' |
The label of the button added by self::$optIntoEdit
Definition at line 35 of file FieldText.inc.php.
Referenced by PKP\components\forms\FieldText\getConfig().
◆ $prefix
| string FieldText::$prefix = '' |
A prefix to display before the input value
Definition at line 47 of file FieldText.inc.php.
Referenced by PKP\components\forms\FieldText\getConfig().
◆ $size
| string FieldText::$size = 'normal' |
Accepts: small, normal or large
Definition at line 41 of file FieldText.inc.php.
Referenced by PKP\components\forms\FieldText\getConfig().
The documentation for this class was generated from the following file:
