Public Member Functions | |
| getConfig () | |
 Public Member Functions inherited from PKP\components\forms\Field | |
| __construct ($name, $args=array()) | |
| getEmptyValue () | |
| validate () | |
Data Fields | |
| $assignIdLabel | |
| $clearIdLabel | |
| $component = 'field-pub-id' | |
| $contextInitials | |
| $isPForPress = false | |
| $issueNumber | |
| $issueVolume | |
| $missingPartsLabel | |
| $pages | |
| $pattern | |
| $prefix | |
| $publicationId | |
| $publisherId | |
| $separator = '' | |
| $submissionId | |
| $year | |
| 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 FieldPubId.inc.php.
Member Function Documentation
◆ getConfig()
| PKP\components\forms\FieldPubId::getConfig | ( | ) |
Get a configuration object representing this field to be passed to the UI Library
- Returns
- array
Reimplemented from PKP\components\forms\Field.
Definition at line 112 of file FieldPubId.inc.php.
References PKP\components\forms\FieldPubId\$assignIdLabel, PKP\components\forms\FieldPubId\$clearIdLabel, PKP\components\forms\FieldPubId\$contextInitials, PKP\components\forms\FieldPubId\$isPForPress, PKP\components\forms\FieldPubId\$issueNumber, PKP\components\forms\FieldPubId\$issueVolume, PKP\components\forms\FieldPubId\$missingPartsLabel, PKP\components\forms\FieldPubId\$pages, PKP\components\forms\FieldPubId\$pattern, PKP\components\forms\FieldPubId\$prefix, PKP\components\forms\FieldPubId\$publicationId, PKP\components\forms\FieldPubId\$publisherId, PKP\components\forms\FieldPubId\$separator, PKP\components\forms\FieldPubId\$submissionId, and PKP\components\forms\FieldPubId\$year.
Field Documentation
◆ $assignIdLabel
| string FieldPubId::$assignIdLabel |
A localized label for the button to assign the pubid
Definition at line 23 of file FieldPubId.inc.php.
Referenced by PKP\components\forms\FieldPubId\getConfig().
◆ $clearIdLabel
| string FieldPubId::$clearIdLabel |
A localized label for the button to clear the pubid
Definition at line 29 of file FieldPubId.inc.php.
Referenced by PKP\components\forms\FieldPubId\getConfig().
◆ $component
| PKP\components\forms\FieldPubId::$component = 'field-pub-id' |
Which UI Library component this field represents
Definition at line 17 of file FieldPubId.inc.php.
◆ $contextInitials
| string FieldPubId::$contextInitials |
The journal/press initials to use when generating a pub id
Definition at line 35 of file FieldPubId.inc.php.
Referenced by PKP\components\forms\FieldPubId\getConfig().
◆ $isPForPress
| boolean FieldPubId::$isPForPress = false |
If a p in the pattern should stand for press (OMP). Otherwise it means pages (OJS).
Definition at line 41 of file FieldPubId.inc.php.
Referenced by PKP\components\forms\FieldPubId\getConfig().
◆ $issueNumber
| string FieldPubId::$issueNumber |
The issue number to use when generating a pub id
Definition at line 47 of file FieldPubId.inc.php.
Referenced by PKP\components\forms\FieldPubId\getConfig().
◆ $issueVolume
| string FieldPubId::$issueVolume |
The issue volume to use when generating a pub id
Definition at line 53 of file FieldPubId.inc.php.
Referenced by PKP\components\forms\FieldPubId\getConfig().
◆ $missingPartsLabel
| string FieldPubId::$missingPartsLabel |
A localized message when the pub id can not be generated due to missing information
Definition at line 59 of file FieldPubId.inc.php.
Referenced by PKP\components\forms\FieldPubId\getConfig().
◆ $pages
| string FieldPubId::$pages |
The page numbers use when generating a pub id
Definition at line 65 of file FieldPubId.inc.php.
Referenced by PKP\components\forms\FieldPubId\getConfig().
◆ $pattern
| string FieldPubId::$pattern |
The pattern to use when generating a pub id
Definition at line 71 of file FieldPubId.inc.php.
Referenced by PKP\components\forms\FieldPubId\getConfig().
◆ $prefix
| string FieldPubId::$prefix |
The pub id prefix for this context
Definition at line 77 of file FieldPubId.inc.php.
Referenced by PKP\components\forms\FieldPubId\getConfig().
◆ $publicationId
| string FieldPubId::$publicationId |
The publication ID to use when generating a pub id
Definition at line 101 of file FieldPubId.inc.php.
Referenced by PKP\components\forms\FieldPubId\getConfig().
◆ $publisherId
| string FieldPubId::$publisherId |
The publisher id to use when generating a pub id
Definition at line 83 of file FieldPubId.inc.php.
Referenced by PKP\components\forms\FieldPubId\getConfig().
◆ $separator
| string FieldPubId::$separator = '' |
Optional separator to add between prefix and suffix when generating pub id
Definition at line 89 of file FieldPubId.inc.php.
Referenced by PKP\components\forms\FieldPubId\getConfig().
◆ $submissionId
| string FieldPubId::$submissionId |
The submission ID to use when generating a pub id
Definition at line 95 of file FieldPubId.inc.php.
Referenced by PKP\components\forms\FieldPubId\getConfig().
◆ $year
| string FieldPubId::$year |
The year of publication to use when generating a pub id
Definition at line 107 of file FieldPubId.inc.php.
Referenced by PKP\components\forms\FieldPubId\getConfig().
The documentation for this class was generated from the following file:
