Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
AuthorSubmission Class Reference
Inheritance diagram for AuthorSubmission:
Article Submission DataObject

Public Member Functions

 addReviewAssignment ($reviewAssignment)
 
 AuthorSubmission ()
 
 getAuthorFileRevisions ($round=null)
 
 getDecisions ($round=null)
 
getEditAssignments ()
 
 getEditorFileRevisions ($round=null)
 
getGalleys ()
 
 getMostRecentCopyeditComment ()
 
 getMostRecentDecision ()
 
 getMostRecentEditorDecisionComment ()
 
 getMostRecentLayoutComment ()
 
 getMostRecentProofreadComment ()
 
getReviewAssignments ($round=null)
 
getRevisedFile ()
 
getSubmissionFile ()
 
 getSubmissionStatus ()
 
getSuppFiles ()
 
 removeReviewAssignment ($reviewId)
 
 setAuthorFileRevisions ($authorFileRevisions, $round)
 
 setDecisions ($editorDecisions, $round)
 
 setEditAssignments ($editAssignments)
 
 setEditorFileRevisions ($editorFileRevisions, $round)
 
 setGalleys (&$galleys)
 
 setMostRecentCopyeditComment ($mostRecentCopyeditComment)
 
 setMostRecentEditorDecisionComment ($mostRecentEditorDecisionComment)
 
 setMostRecentLayoutComment ($mostRecentLayoutComment)
 
 setMostRecentProofreadComment ($mostRecentProofreadComment)
 
 setReviewAssignments ($reviewAssignments, $round)
 
 setRevisedFile ($revisedFile)
 
 setSubmissionFile ($submissionFile)
 
 setSuppFiles ($suppFiles)
 
- Public Member Functions inherited from Article
 Article ()
 
 getArticleAbstract ()
 
 getArticleCoverageChron ()
 
 getArticleCoverageGeo ()
 
 getArticleCoverageSample ()
 
 getArticleCoverPageAltText ()
 
 getArticleDiscipline ()
 
 getArticleFileName ()
 
 getArticleHeight ()
 
 getArticleId ()
 
 getArticleOriginalFileName ()
 
 getArticleShowCoverPage ()
 
 getArticleSponsor ()
 
 getArticleSubject ()
 
 getArticleSubjectClass ()
 
 getArticleTitle ()
 
 getArticleType ()
 
 getArticleWidth ()
 
 getAssociatedUserIds ($authors=true, $reviewers=true, $editors=true, $proofreader=true, $copyeditor=true, $layoutEditor=true)
 
 getAssocType ()
 
 getBestArticleId ($journal=null)
 
getCommentsStatusOptions ()
 
 getCommentsStatusString ()
 
 getCommentsToEditor ()
 
 getCurrentRound ()
 
 getEditorFileId ()
 
 getEnableComments ()
 
 getFastTracked ()
 
getFileBySignoffType ($signoffType, $idOnly=false)
 
 getHideAuthor ()
 
 getJournalId ()
 
 getSectionAbbrev ()
 
 getSectionId ()
 
 getSectionTitle ()
 
 getSignoff ($signoffType)
 
 getStoredPubId ($pubIdType)
 
getUserBySignoffType ($signoffType)
 
 getUserIdBySignoffType ($signoffType)
 
 setArticleId ($articleId)
 
 setCommentsToEditor ($commentsToEditor)
 
 setCurrentRound ($currentRound)
 
 setEditorFileId ($editorFileId)
 
 setFastTracked ($fastTracked)
 
 setHideAuthor ($hideAuthor)
 
 setJournalId ($journalId)
 
 setSectionAbbrev ($sectionAbbrev)
 
 setSectionId ($sectionId)
 
 setSectionTitle ($sectionTitle)
 
 setStoredPubId ($pubIdType, $pubId)
 
- Public Member Functions inherited from Submission
 getAbstract ($locale)
 
 getAssocType ()
 
 getAuthorEmails ()
 
getAuthors ()
 
 getAuthorString ($lastOnly=false, $separator= ', ')
 
 getCitations ()
 
 getCommentsStatus ()
 
 getCoverageChron ($locale)
 
 getCoverageGeo ($locale)
 
 getCoverageSample ($locale)
 
 getCoverPageAltText ($locale)
 
 getDateStatusModified ()
 
 getDateSubmitted ()
 
 getDiscipline ($locale)
 
 getFileName ($locale)
 
 getFirstAuthor ($lastOnly=false)
 
 getHeight ($locale)
 
 getHideCoverPageAbstract ($locale)
 
 getHideCoverPageToc ($locale)
 
 getLanguage ()
 
 getLastModified ()
 
 getLocale ()
 
 getLocalizedAbstract ()
 
 getLocalizedCoverageChron ()
 
 getLocalizedCoverageGeo ()
 
 getLocalizedCoverageSample ()
 
 getLocalizedCoverPageAltText ()
 
getLocalizedData ($key, $preferredLocale=null)
 
 getLocalizedDiscipline ()
 
 getLocalizedFileName ()
 
 getLocalizedHeight ()
 
 getLocalizedHideCoverPageAbstract ()
 
 getLocalizedOriginalFileName ()
 
 getLocalizedPrefix ()
 
 getLocalizedShowCoverPage ()
 
 getLocalizedSponsor ()
 
 getLocalizedSubject ()
 
 getLocalizedSubjectClass ()
 
 getLocalizedTitle ($preferredLocale=null)
 
 getLocalizedType ()
 
 getLocalizedWidth ()
 
 getOriginalFileName ($locale)
 
 getPages ()
 
 getPrefix ($locale)
 
getPrimaryAuthor ()
 
 getReviewFileId ()
 
 getRevisedFileId ()
 
 getRights ($locale)
 
 getShowCoverPage ($locale)
 
 getSource ($locale)
 
 getSponsor ($locale)
 
 getStatus ()
 
 getStatusKey ()
 
getStatusMap ()
 
 getSubject ($locale)
 
 getSubjectClass ($locale)
 
 getSubmissionFileId ()
 
 getSubmissionProgress ()
 
 getTitle ($locale)
 
 getType ($locale)
 
 getUser ()
 
 getUserId ()
 
 getWidth ($locale)
 
 setAbstract ($abstract, $locale)
 
 setCitations ($citations)
 
 setCleanTitle ($cleanTitle, $locale)
 
 setCommentsStatus ($commentsStatus)
 
 setCoverageChron ($coverageChron, $locale)
 
 setCoverageGeo ($coverageGeo, $locale)
 
 setCoverageSample ($coverageSample, $locale)
 
 setCoverPageAltText ($coverPageAltText, $locale)
 
 setDateStatusModified ($dateModified)
 
 setDateSubmitted ($dateSubmitted)
 
 setDiscipline ($discipline, $locale)
 
 setFileName ($fileName, $locale)
 
 setHeight ($height, $locale)
 
 setHideCoverPageAbstract ($hideCoverPageAbstract, $locale)
 
 setHideCoverPageToc ($hideCoverPageToc, $locale)
 
 setLanguage ($language)
 
 setLastModified ($dateModified)
 
 setLocale ($locale)
 
 setOriginalFileName ($originalFileName, $locale)
 
 setPages ($pages)
 
 setPrefix ($prefix, $locale)
 
 setReviewFileId ($reviewFileId)
 
 setRevisedFileId ($revisedFileId)
 
 setRights ($rights, $locale)
 
 setShowCoverPage ($showCoverPage, $locale)
 
 setSource ($source, $locale)
 
 setSponsor ($sponsor, $locale)
 
 setStatus ($status)
 
 setSubject ($subject, $locale)
 
 setSubjectClass ($subjectClass, $locale)
 
 setSubmissionFileId ($submissionFileId)
 
 setSubmissionProgress ($submissionProgress)
 
 setTitle ($title, $locale)
 
 setType ($type, $locale)
 
 setUserId ($userId)
 
 setWidth ($width, $locale)
 
 stampModified ()
 
 stampStatusModified ()
 
 Submission ()
 
- Public Member Functions inherited from DataObject
 addSupportedMetadataAdapter (&$metadataAdapter)
 
 DataObject ($callHooks=true)
 
extractMetadata (&$metadataSchema)
 
 getAdditionalMetadataFieldNames ()
 
getAllData ()
 
getData ($key, $locale=null)
 
 getHasLoadableAdapters ()
 
 getId ()
 
 getLocaleMetadataFieldNames ()
 
getLocalizedData ($key)
 
 getMetadataFieldNames ($translated=true)
 
 getSetMetadataFieldNames ($translated=true)
 
getSupportedExtractionAdapters ()
 
getSupportedInjectionAdapters ()
 
getSupportedMetadataSchemas ()
 
 hasData ($key, $locale=null)
 
 injectMetadata (&$metadataDescription)
 
 removeSupportedMetadataAdapter ($metadataSchemaName)
 
 setAllData (&$data)
 
 setData ($key, $value, $locale=null)
 
 setHasLoadableAdapters ($hasLoadableAdapters)
 
 setId ($id)
 
upcastTo (&$targetObject)
 

Additional Inherited Members

- Public Attributes inherited from DataObject
 $_data = array()
 

Detailed Description

AuthorSubmission class.

See Also
AuthorSubmissionDAO

Definition at line 19 of file AuthorSubmission.inc.php.

Member Function Documentation

AuthorSubmission::addReviewAssignment (   $reviewAssignment)

Add a review assignment for this article.

Parameters
$reviewAssignmentReviewAssignment

Definition at line 69 of file AuthorSubmission.inc.php.

References Article\getArticleId().

AuthorSubmission::AuthorSubmission ( )

Constructor.

Definition at line 39 of file AuthorSubmission.inc.php.

AuthorSubmission::getAuthorFileRevisions (   $round = null)

Get all author file revisions.

Returns
array ArticleFiles

Definition at line 253 of file AuthorSubmission.inc.php.

AuthorSubmission::getDecisions (   $round = null)

Get editor decisions.

Returns
array

Definition at line 131 of file AuthorSubmission.inc.php.

Referenced by getMostRecentDecision().

& AuthorSubmission::getEditAssignments ( )

Get/Set Methods. Get edit assignments for this article.

Returns
array

Definition at line 52 of file AuthorSubmission.inc.php.

References DataObject\getData().

Referenced by getSubmissionStatus().

AuthorSubmission::getEditorFileRevisions (   $round = null)

Get all editor file revisions.

Returns
array ArticleFiles

Definition at line 273 of file AuthorSubmission.inc.php.

& AuthorSubmission::getGalleys ( )

Get the galleys for an article.

Returns
array ArticleGalley

Definition at line 293 of file AuthorSubmission.inc.php.

References DataObject\getData().

AuthorSubmission::getMostRecentCopyeditComment ( )

Get most recent copyedit comment.

Returns
ArticleComment

Definition at line 330 of file AuthorSubmission.inc.php.

References DataObject\getData().

AuthorSubmission::getMostRecentDecision ( )

Get the most recent decision.

Returns
int SUBMISSION_EDITOR_DECISION_...

Definition at line 184 of file AuthorSubmission.inc.php.

References getDecisions().

Referenced by getSubmissionStatus().

AuthorSubmission::getMostRecentEditorDecisionComment ( )

Get most recent editor decision comment.

Returns
ArticleComment

Definition at line 314 of file AuthorSubmission.inc.php.

References DataObject\getData().

AuthorSubmission::getMostRecentLayoutComment ( )

Get most recent layout comment.

Returns
ArticleComment

Definition at line 346 of file AuthorSubmission.inc.php.

References DataObject\getData().

AuthorSubmission::getMostRecentProofreadComment ( )

Get most recent proofread comment.

Returns
ArticleComment

Definition at line 362 of file AuthorSubmission.inc.php.

References DataObject\getData().

& AuthorSubmission::getReviewAssignments (   $round = null)

Get review assignments for this article.

Returns
array ReviewAssignments

Definition at line 105 of file AuthorSubmission.inc.php.

& AuthorSubmission::getRevisedFile ( )

Get revised file for this article.

Returns
ArticleFile

Definition at line 219 of file AuthorSubmission.inc.php.

References DataObject\getData().

& AuthorSubmission::getSubmissionFile ( )

Get submission file for this article.

Returns
ArticleFile

Definition at line 202 of file AuthorSubmission.inc.php.

References DataObject\getData().

AuthorSubmission::getSubmissionStatus ( )

Get the submission status. Returns one of the defined constants (STATUS_INCOMPLETE, STATUS_ARCHIVED, STATUS_PUBLISHED, STATUS_DECLINED, STATUS_QUEUED_UNASSIGNED, STATUS_QUEUED_REVIEW, or STATUS_QUEUED_EDITING). Note that this function never returns a value of STATUS_QUEUED – the three STATUS_QUEUED_... constants indicate a queued submission. NOTE that this code is similar to getSubmissionStatus in the SectionEditorSubmission class and changes here should be propagated.

Definition at line 158 of file AuthorSubmission.inc.php.

References getEditAssignments(), getMostRecentDecision(), Submission\getStatus(), and Submission\getSubmissionProgress().

& AuthorSubmission::getSuppFiles ( )

Get supplementary files for this article.

Returns
array SuppFiles

Definition at line 236 of file AuthorSubmission.inc.php.

References DataObject\getData().

AuthorSubmission::removeReviewAssignment (   $reviewId)

Remove a review assignment.

Parameters
$reviewIdID of the review assignment to remove
Returns
boolean review assignment was removed

Definition at line 82 of file AuthorSubmission.inc.php.

AuthorSubmission::setAuthorFileRevisions (   $authorFileRevisions,
  $round 
)

Set all author file revisions.

Parameters
$authorFileRevisionsarray ArticleFiles

Definition at line 265 of file AuthorSubmission.inc.php.

AuthorSubmission::setDecisions (   $editorDecisions,
  $round 
)

Set editor decisions.

Parameters
$editorDecisionsarray
$roundint

Definition at line 144 of file AuthorSubmission.inc.php.

AuthorSubmission::setEditAssignments (   $editAssignments)

Set edit assignments for this article.

Parameters
$editAssignmentsarray

Definition at line 61 of file AuthorSubmission.inc.php.

References DataObject\setData().

AuthorSubmission::setEditorFileRevisions (   $editorFileRevisions,
  $round 
)

Set all editor file revisions.

Parameters
$editorFileRevisionsarray ArticleFiles

Definition at line 285 of file AuthorSubmission.inc.php.

AuthorSubmission::setGalleys ( $galleys)

Set the galleys for an article.

Parameters
$galleysarray ArticleGalley

Definition at line 302 of file AuthorSubmission.inc.php.

References DataObject\setData().

AuthorSubmission::setMostRecentCopyeditComment (   $mostRecentCopyeditComment)

Set most recent copyedit comment.

Parameters
$mostRecentCopyeditCommentArticleComment

Definition at line 338 of file AuthorSubmission.inc.php.

References DataObject\setData().

AuthorSubmission::setMostRecentEditorDecisionComment (   $mostRecentEditorDecisionComment)

Set most recent editor decision comment.

Parameters
$mostRecentEditorDecisionCommentArticleComment

Definition at line 322 of file AuthorSubmission.inc.php.

References DataObject\setData().

AuthorSubmission::setMostRecentLayoutComment (   $mostRecentLayoutComment)

Set most recent layout comment.

Parameters
$mostRecentLayoutCommentArticleComment

Definition at line 354 of file AuthorSubmission.inc.php.

References DataObject\setData().

AuthorSubmission::setMostRecentProofreadComment (   $mostRecentProofreadComment)

Set most recent proofread comment.

Parameters
$mostRecentProofreadCommentArticleComment

Definition at line 370 of file AuthorSubmission.inc.php.

References DataObject\setData().

AuthorSubmission::setReviewAssignments (   $reviewAssignments,
  $round 
)

Set review assignments for this article.

Parameters
$reviewAssignmentsarray ReviewAssignments

Definition at line 119 of file AuthorSubmission.inc.php.

AuthorSubmission::setRevisedFile (   $revisedFile)

Set revised file for this article.

Parameters
$submissionFileArticleFile

Definition at line 228 of file AuthorSubmission.inc.php.

References DataObject\setData().

AuthorSubmission::setSubmissionFile (   $submissionFile)

Set submission file for this article.

Parameters
$submissionFileArticleFile

Definition at line 211 of file AuthorSubmission.inc.php.

References DataObject\setData().

AuthorSubmission::setSuppFiles (   $suppFiles)

Set supplementary file for this article.

Parameters
$suppFilesarray SuppFiles

Definition at line 245 of file AuthorSubmission.inc.php.

References DataObject\setData().


The documentation for this class was generated from the following file: