Open Journal Systems
3.3.0
|
Additional Inherited Members | |
![]() | |
$_data = array() | |
$_extractionAdaptersLoaded = false | |
$_hasLoadableAdapters = false | |
$_injectionAdaptersLoaded = false | |
$_metadataExtractionAdapters = array() | |
$_metadataInjectionAdapters = array() | |
The Submission class implements the abstract data model of a scholarly submission.
Definition at line 36 of file PKPSubmission.inc.php.
PKPSubmission::__construct | ( | ) |
Constructor.
Reimplemented from DataObject.
Definition at line 40 of file PKPSubmission.inc.php.
References DataObject\setHasLoadableAdapters().
|
abstract |
Get the value of a license field from the containing context.
$locale | string Locale code |
$field | PERMISSIONS_FIELD_... |
PKPSubmission::getAbstract | ( | $locale | ) |
Get abstract.
$locale |
Definition at line 650 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::getAuthorEmails | ( | ) |
Return a list of author email addresses of the current publication.
Definition at line 403 of file PKPSubmission.inc.php.
References Mail\encodeDisplayName(), and getAuthors().
PKPSubmission::getAuthors | ( | $onlyIncludeInBrowse = false | ) |
Get all authors of the current publication
$onlyIncludeInBrowse | boolean whether to limit to include_in_browse authors. |
Definition at line 420 of file PKPSubmission.inc.php.
References getCurrentPublication().
Referenced by getAuthorEmails(), and getAuthorString().
PKPSubmission::getAuthorString | ( | $preferred = true , |
|
$familyOnly = false |
|||
) |
Return string of author names, separated by the specified token
$preferred | boolean If the preferred public name should be used, if exist |
$familyOnly | boolean return list of family names only (default false) |
Definition at line 368 of file PKPSubmission.inc.php.
References getAuthors(), getCurrentPublication(), and DAORegistry\getDAO().
PKPSubmission::getBestId | ( | ) |
Return the "best" article ID – If a urlPath is set, use it; otherwise use the internal article Id.
Definition at line 53 of file PKPSubmission.inc.php.
References getCurrentPublication(), and DataObject\getId().
PKPSubmission::getCitations | ( | ) |
Get citations.
Definition at line 982 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::getContextId | ( | ) |
Get the context ID for the current publication
Definition at line 210 of file PKPSubmission.inc.php.
References DataObject\getData().
PKPSubmission::getCopyrightHolder | ( | $locale | ) |
Get stored copyright holder for the submission.
$locale | string locale |
Definition at line 277 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::getCopyrightNotice | ( | $locale | ) |
Get the copyright notice for a given locale
$locale | string |
Definition at line 956 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::getCopyrightYear | ( | ) |
Get stored copyright year for the submission.
Definition at line 303 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::getCoverage | ( | $locale | ) |
Get coverage.
$locale |
Definition at line 770 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::getCurrentPublication | ( | ) |
Get the current publication
Uses the currentPublicationId
to get the current Publication object from the submission's list of publications.
Definition at line 68 of file PKPSubmission.inc.php.
References DataObject\getData().
Referenced by Submission\_getContextLicenseFieldValue(), getAbstract(), getAuthors(), getAuthorString(), getBestId(), getCitations(), getCopyrightHolder(), getCopyrightNotice(), getCopyrightYear(), getCoverage(), Submission\getCoverImage(), Submission\getCoverImageAltText(), getDatePublished(), getDiscipline(), getEndingPage(), getFullTitle(), Submission\getGalleys(), Submission\getHideAuthor(), getLanguage(), getLicenseURL(), getLocale(), getLocalizedAbstract(), getLocalizedCopyrightHolder(), getLocalizedCoverage(), Submission\getLocalizedCoverImage(), Submission\getLocalizedCoverImageAltText(), Submission\getLocalizedCoverImageUrl(), getLocalizedData(), getLocalizedDiscipline(), getLocalizedFullTitle(), getLocalizedPrefix(), getLocalizedSponsor(), getLocalizedSubject(), getLocalizedSubtitle(), getLocalizedTitle(), getLocalizedType(), getPageArray(), getPages(), getPrefix(), getPrimaryAuthor(), getRights(), Submission\getSectionId(), getShortAuthorString(), getSource(), getSponsor(), getStartingPage(), getStoredPubId(), getSubject(), getSubtitle(), getTitle(), getType(), isCCLicense(), setAbstract(), setCitations(), setCopyrightHolder(), setCopyrightNotice(), setCopyrightYear(), setCoverage(), setDatePublished(), setDiscipline(), setHideAuthor(), setLanguage(), setLicenseURL(), setLocale(), setPages(), setPrefix(), setRights(), Submission\setSectionId(), setSource(), setSponsor(), setStoredPubId(), setSubject(), setSubtitle(), and setType().
PKPSubmission::getDAO | ( | ) |
Get DAO class name for this object.
Reimplemented from DataObject.
Definition at line 166 of file PKPSubmission.inc.php.
References DAORegistry\getDAO().
PKPSubmission::getDatePublished | ( | ) |
Get date published.
Definition at line 1171 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::getDateStatusModified | ( | ) |
Get the date of the last status modification.
Definition at line 1025 of file PKPSubmission.inc.php.
References DataObject\getData().
PKPSubmission::getDateSubmitted | ( | ) |
Get submission date.
Definition at line 1007 of file PKPSubmission.inc.php.
References DataObject\getData().
PKPSubmission::getDiscipline | ( | $locale | ) |
Get discipline
$locale |
Definition at line 690 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::getEndingPage | ( | ) |
Get ending page of a submission. Note the return type of string - this is not to be used for page counting.
Definition at line 1120 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::getFullTitle | ( | $locale | ) |
Get the submission full title (with prefix, title and subtitle).
$locale | string Locale to fetch data in. |
Definition at line 580 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::getLanguage | ( | ) |
Get language.
Definition at line 890 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::getLastModified | ( | ) |
Get the date of the last modification.
Definition at line 1043 of file PKPSubmission.inc.php.
References DataObject\getData().
PKPSubmission::getLatestPublication | ( | ) |
Get the latest publication
Returns the most recently created publication by ID
Definition at line 88 of file PKPSubmission.inc.php.
References DataObject\getData().
PKPSubmission::getLicenseURL | ( | ) |
Get stored license URL for the submission content.
Definition at line 328 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::getLocale | ( | ) |
Get the locale of the submission.
Definition at line 453 of file PKPSubmission.inc.php.
References getCurrentPublication().
Referenced by Submission\getLocalizedGalleys().
PKPSubmission::getLocalizedAbstract | ( | ) |
Get "localized" submission abstract (if applicable).
Definition at line 636 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::getLocalizedCopyrightHolder | ( | $preferredLocale = null | ) |
Get the localized copyright holder for the current publication
$preferredLocale | string Preferred locale code |
Definition at line 197 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::getLocalizedCoverage | ( | ) |
Return the localized coverage
Definition at line 756 of file PKPSubmission.inc.php.
References getCurrentPublication().
& PKPSubmission::getLocalizedData | ( | $key, | |
$preferredLocale = null |
|||
) |
Get a piece of data for this object, localized to the current locale of the current publication if possible.
$key | string |
$preferredLocale | string |
$returnLocale | string Optional reference to string receiving return value's locale |
Reimplemented from DataObject.
Definition at line 232 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::getLocalizedDiscipline | ( | ) |
Return the localized discipline
Definition at line 676 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::getLocalizedFullTitle | ( | ) |
Get the submission full title (with prefix, title and subtitle).
Definition at line 565 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::getLocalizedPrefix | ( | ) |
Get "localized" submission prefix (if applicable).
Definition at line 596 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::getLocalizedSponsor | ( | ) |
Return the localized sponsor
Definition at line 915 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::getLocalizedSubject | ( | ) |
Return the localized subject
Definition at line 716 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::getLocalizedSubtitle | ( | ) |
Get the localized version of the subtitle
Definition at line 524 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::getLocalizedTitle | ( | $preferredLocale = null , |
|
$includePrefix = true |
|||
) |
Get "localized" submission title (if applicable).
$preferredLocale | string |
$includePrefix | bool |
Definition at line 480 of file PKPSubmission.inc.php.
References getCurrentPublication().
Referenced by SwordPlugin\performAutomaticDeposits().
PKPSubmission::getLocalizedType | ( | ) |
Return the localized type (method/approach)
Definition at line 796 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::getPageArray | ( | ) |
get pages as a nested array of page ranges for example, pages of "pp. ii-ix, 9,15-18,a2,b2-b6" will return array( array(0 => 'ii', 1, => 'ix'), array(0 => '9'), array(0 => '15', 1 => '18'), array(0 => 'a2'), array(0 => 'b2', 1 => 'b6') )
Definition at line 1131 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::getPages | ( | ) |
get pages
Definition at line 1097 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::getPrefix | ( | $locale | ) |
Get prefix.
$locale |
Definition at line 610 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::getPrimaryAuthor | ( | ) |
Get the primary author of the current publication
Definition at line 440 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::getPublishedPublications | ( | ) |
Get the published publications
Returns publications with the STATUS_PUBLISHED status
Definition at line 105 of file PKPSubmission.inc.php.
References DataObject\getData().
PKPSubmission::getRights | ( | $locale | ) |
Get rights.
$locale |
Definition at line 837 of file PKPSubmission.inc.php.
References getCurrentPublication().
|
abstract |
PKPSubmission::getShortAuthorString | ( | ) |
Return short author names string.
Definition at line 390 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::getSource | ( | $locale | ) |
Get source.
$locale |
Definition at line 864 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::getSponsor | ( | $locale | ) |
Get sponsor.
$locale |
Definition at line 929 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::getStageId | ( | ) |
Get the submission's current publication stage ID
Reimplemented in ReviewerSubmission.
Definition at line 1153 of file PKPSubmission.inc.php.
References DataObject\getData().
PKPSubmission::getStartingPage | ( | ) |
Get starting page of a submission. Note the return type of string - this is not to be used for page counting.
Definition at line 1110 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::getStatus | ( | ) |
Get submission status.
Definition at line 1061 of file PKPSubmission.inc.php.
References DataObject\getData().
PKPSubmission::getStatusKey | ( | ) |
Get a locale key for the paper's current status.
Definition at line 158 of file PKPSubmission.inc.php.
References DataObject\getData(), and getStatusMap().
& PKPSubmission::getStatusMap | ( | ) |
Get a map for status constant to locale key.
Definition at line 141 of file PKPSubmission.inc.php.
Referenced by getStatusKey().
PKPSubmission::getStoredPubId | ( | $pubIdType | ) |
Get stored public ID of the submission.
Definition at line 248 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::getSubject | ( | $locale | ) |
Get subject.
$locale |
Definition at line 730 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::getSubmissionProgress | ( | ) |
Get submission progress (most recently completed submission step).
Definition at line 1079 of file PKPSubmission.inc.php.
References DataObject\getData().
PKPSubmission::getSubtitle | ( | $locale | ) |
Get the subtitle for a given locale
$locale | string |
Definition at line 538 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::getTitle | ( | $locale, | |
$includePrefix = true |
|||
) |
Get title.
$locale | |
$includePrefix | bool |
Definition at line 495 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::getType | ( | $locale | ) |
Get type (method/approach).
$locale |
Definition at line 810 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::getViews | ( | ) |
Get views of the submission.
Definition at line 1206 of file PKPSubmission.inc.php.
References $application, PKPApplication\getApplication(), and DataObject\getId().
PKPSubmission::isCCLicense | ( | ) |
Determines whether or not the license for copyright on this submission is a Creative Commons license or not.
Definition at line 1197 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::setAbstract | ( | $abstract, | |
$locale | |||
) |
Set abstract.
$abstract | string |
$locale |
Definition at line 664 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::setCitations | ( | $citations | ) |
Set citations.
$citations | string |
Definition at line 995 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::setContextId | ( | $contextId | ) |
Set the context ID for the current publication
$contextId | int |
Definition at line 219 of file PKPSubmission.inc.php.
References DataObject\setData().
PKPSubmission::setCopyrightHolder | ( | $copyrightHolder, | |
$locale | |||
) |
Set the stored copyright holder for the submission.
$copyrightHolder | string Copyright holder |
$locale | string locale |
Definition at line 291 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::setCopyrightNotice | ( | $copyrightNotice, | |
$locale | |||
) |
Set the copyright notice for a locale
$copyrightNotice | string |
$locale | string |
Definition at line 970 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::setCopyrightYear | ( | $copyrightYear | ) |
Set the stored copyright year for the submission.
$copyrightYear | string Copyright holder |
Definition at line 316 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::setCoverage | ( | $coverage, | |
$locale | |||
) |
Set coverage.
$coverage | string |
$locale |
Definition at line 784 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::setDatePublished | ( | $datePublished | ) |
Set date published.
$datePublished | date |
Definition at line 1184 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::setDateStatusModified | ( | $dateModified | ) |
Set the date of the last status modification.
$dateModified | date |
Definition at line 1034 of file PKPSubmission.inc.php.
References DataObject\setData().
PKPSubmission::setDateSubmitted | ( | $dateSubmitted | ) |
Set submission date.
$dateSubmitted | date |
Definition at line 1016 of file PKPSubmission.inc.php.
References DataObject\setData().
PKPSubmission::setDiscipline | ( | $discipline, | |
$locale | |||
) |
Set discipline
$discipline | string |
$locale |
Definition at line 704 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::setHideAuthor | ( | $hideAuthor | ) |
Set option selection indicating if author should be hidden in issue ToC.
$hideAuthor | int AUTHOR_TOC_... |
Definition at line 353 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::setLanguage | ( | $language | ) |
Set language.
$language | string |
Definition at line 903 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::setLastModified | ( | $dateModified | ) |
Set the date of the last modification.
$dateModified | date |
Definition at line 1052 of file PKPSubmission.inc.php.
References DataObject\setData().
PKPSubmission::setLicenseURL | ( | $licenseURL | ) |
Set the stored license URL for the submission content.
$license | string License of submission content |
Definition at line 341 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::setLocale | ( | $locale | ) |
Set the locale of the submission.
$locale | string |
Definition at line 466 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::setPages | ( | $pages | ) |
set pages
$pages | string |
Definition at line 1141 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::setPrefix | ( | $prefix, | |
$locale | |||
) |
Set prefix.
$prefix | string |
$locale |
Definition at line 624 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::setRights | ( | $rights, | |
$locale | |||
) |
Set rights.
$rights | string |
$locale |
Definition at line 851 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::setSource | ( | $source, | |
$locale | |||
) |
Set source.
$source | string |
$locale |
Definition at line 878 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::setSponsor | ( | $sponsor, | |
$locale | |||
) |
Set sponsor.
$sponsor | string |
$locale |
Definition at line 943 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::setStageId | ( | $stageId | ) |
Set the submission's current publication stage ID
$stageId | int |
Reimplemented in ReviewerSubmission.
Definition at line 1162 of file PKPSubmission.inc.php.
References DataObject\setData().
PKPSubmission::setStatus | ( | $status | ) |
Set submission status.
$status | int |
Definition at line 1070 of file PKPSubmission.inc.php.
References DataObject\setData().
PKPSubmission::setStoredPubId | ( | $pubIdType, | |
$pubId | |||
) |
Set the stored public ID of the submission.
$pubIdType | string One of the NLM pub-id-type values or 'other::something' if not part of the official NLM list (see http://dtd.nlm.nih.gov/publishing/tag-library/n-4zh0.html). |
$pubId | string |
Definition at line 264 of file PKPSubmission.inc.php.
References getCurrentPublication(), and DataObject\setData().
PKPSubmission::setSubject | ( | $subject, | |
$locale | |||
) |
Set subject.
$subject | string |
$locale |
Definition at line 744 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::setSubmissionProgress | ( | $submissionProgress | ) |
Set submission progress.
$submissionProgress | int |
Definition at line 1088 of file PKPSubmission.inc.php.
References DataObject\setData().
PKPSubmission::setSubtitle | ( | $subtitle, | |
$locale | |||
) |
Set the subtitle for a locale
$subtitle | string |
$locale | string |
Definition at line 552 of file PKPSubmission.inc.php.
References getCurrentPublication(), and DataObject\setData().
PKPSubmission::setTitle | ( | $title, | |
$locale | |||
) |
Set title.
$title | string |
$locale |
Definition at line 515 of file PKPSubmission.inc.php.
References DataObject\setData().
PKPSubmission::setType | ( | $type, | |
$locale | |||
) |
Set type (method/approach).
$type | string |
$locale |
Definition at line 824 of file PKPSubmission.inc.php.
References getCurrentPublication().
PKPSubmission::stampLastActivity | ( | ) |
Stamp the date of the last recorded activity to the current time
Definition at line 125 of file PKPSubmission.inc.php.
References Core\getCurrentDate(), and DataObject\setData().
Referenced by stampStatusModified().
PKPSubmission::stampModified | ( | ) |
Stamp the date of the last modification to the current time.
Definition at line 118 of file PKPSubmission.inc.php.
References Core\getCurrentDate(), and DataObject\setData().
PKPSubmission::stampStatusModified | ( | ) |
Stamp the date of the last status modification to the current time.
Definition at line 133 of file PKPSubmission.inc.php.
References stampLastActivity().