Public Member Functions | |
| __construct ($name, $args=[]) | |
| getConfig () | |
| getEmptyValue () | |
 Public Member Functions inherited from PKP\components\forms\FieldUpload | |
| validate () | |
Data Fields | |
| $altTextDescription = '' | |
| $altTextLabel = '' | |
| $baseUrl = '' | |
| $component = 'field-upload-image' | |
| $thumbnailDescription = '' | |
| Data Fields inherited from PKP\components\forms\FieldUpload | |
| $component = 'field-upload' | |
| $options = [] | |
| 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 FieldUploadImage.inc.php.
Constructor & Destructor Documentation
◆ __construct()
| PKP\components\forms\FieldUploadImage::__construct | ( | $name, | |
$args = [] |
|||
| ) |
Initialize the form field
- Parameters
-
$name string $args array [ @option label string|object @option groupId string @option isRequired boolean @option isMultilingual boolean ]
Reimplemented from PKP\components\forms\FieldUpload.
Definition at line 46 of file FieldUploadImage.inc.php.
References PKP\components\forms\Field\$name.
Member Function Documentation
◆ getConfig()
| PKP\components\forms\FieldUploadImage::getConfig | ( | ) |
Get a configuration object representing this field to be passed to the UI Library
- Returns
- array
Reimplemented from PKP\components\forms\FieldUpload.
Definition at line 53 of file FieldUploadImage.inc.php.
References PKP\components\forms\FieldUploadImage\$baseUrl.
◆ getEmptyValue()
| PKP\components\forms\FieldUploadImage::getEmptyValue | ( | ) |
Get a default empty value for this field type
The UI Library expects to receive a value property for each field. If it's a multilingual field, it expects the value property to contain keys for each locale in the form.
This function will provide a default empty value so that a form can fill in the empty values automatically.
- Returns
- mixed
Reimplemented from PKP\components\forms\Field.
Definition at line 70 of file FieldUploadImage.inc.php.
Field Documentation
◆ $altTextDescription
| string FieldUploadImage::$altTextDescription = '' |
Description for the alt text field
Definition at line 35 of file FieldUploadImage.inc.php.
◆ $altTextLabel
| string FieldUploadImage::$altTextLabel = '' |
Label for the alt text field
Definition at line 29 of file FieldUploadImage.inc.php.
◆ $baseUrl
| string FieldUploadImage::$baseUrl = '' |
Base url for displaying the image
Definition at line 23 of file FieldUploadImage.inc.php.
Referenced by PKP\components\forms\FieldUploadImage\getConfig().
◆ $component
| PKP\components\forms\FieldUploadImage::$component = 'field-upload-image' |
Which UI Library component this field represents
Definition at line 17 of file FieldUploadImage.inc.php.
◆ $thumbnailDescription
| string FieldUploadImage::$thumbnailDescription = '' |
Description for the image thumbnail
Definition at line 41 of file FieldUploadImage.inc.php.
The documentation for this class was generated from the following file:
