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

Public Member Functions

 addDecision ($editorDecision, $round)
 
 addReviewAssignment ($reviewAssignment)
 
 getAuthorFileRevisions ($round=null)
 
getDecisions ($round=null)
 
getEditAssignments ()
 
getEditorDecisionOptions ()
 
getEditorFile ()
 
 getEditorFileRevisions ($round=null)
 
getGalleys ()
 
 getHighlightClass ()
 
 getMostRecentCopyeditComment ()
 
 getMostRecentEditorDecisionComment ()
 
 getMostRecentLayoutComment ()
 
 getMostRecentProofreadComment ()
 
getRemovedReviewAssignments ()
 
getReviewAssignments ($round=null)
 
getReviewFile ()
 
 getReviewRevision ()
 
getRevisedFile ()
 
getSubmissionFile ()
 
 getSubmissionStatus ()
 
getSuppFiles ()
 
 removeReviewAssignment ($reviewId)
 
 SectionEditorSubmission ()
 
 setAuthorFileRevisions ($authorFileRevisions, $round)
 
 setDecisions ($editorDecisions, $round)
 
 setEditAssignments ($editAssignments)
 
 setEditorFile ($editorFile)
 
 setEditorFileRevisions ($editorFileRevisions, $round)
 
 setGalleys (&$galleys)
 
 setMostRecentCopyeditComment ($mostRecentCopyeditComment)
 
 setMostRecentEditorDecisionComment ($mostRecentEditorDecisionComment)
 
 setMostRecentLayoutComment ($mostRecentLayoutComment)
 
 setMostRecentProofreadComment ($mostRecentProofreadComment)
 
 setReviewAssignments ($reviewAssignments, $round)
 
 setReviewFile ($reviewFile)
 
 setReviewRevision ($reviewRevision)
 
 setRevisedFile ($revisedFile)
 
 setSubmissionFile ($submissionFile)
 
 setSuppFiles ($suppFiles)
 
 updateReviewAssignment ($reviewAssignment)
 
- 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

Member Function Documentation

SectionEditorSubmission::addDecision (   $editorDecision,
  $round 
)

Add an editorial decision for this article.

Parameters
$editorDecisionarray
$roundint

Definition at line 72 of file SectionEditorSubmission.inc.php.

SectionEditorSubmission::addReviewAssignment (   $reviewAssignment)

Add a review assignment for this article.

Parameters
$reviewAssignmentReviewAssignment

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

References DataObject\getId().

SectionEditorSubmission::getAuthorFileRevisions (   $round = null)

Get all author file revisions.

Returns
array ArticleFiles

Definition at line 324 of file SectionEditorSubmission.inc.php.

Referenced by getHighlightClass().

& SectionEditorSubmission::getDecisions (   $round = null)

Get editor decisions.

Returns
array

Definition at line 209 of file SectionEditorSubmission.inc.php.

Referenced by getHighlightClass(), and getSubmissionStatus().

& SectionEditorSubmission::getEditAssignments ( )

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

Returns
array

Definition at line 156 of file SectionEditorSubmission.inc.php.

References DataObject\getData().

Referenced by getHighlightClass(), and getSubmissionStatus().

& SectionEditorSubmission::getEditorDecisionOptions ( )

Return array mapping editor decision constants to their locale strings. (Includes default mapping '' => "Choose One".)

Returns
array decision => localeString

Definition at line 467 of file SectionEditorSubmission.inc.php.

Referenced by SectionEditorAction\recordDecision(), TrackSubmissionHandler\submission(), SubmissionEditHandler\submissionRegrets(), TrackSubmissionHandler\submissionReview(), and SubmissionEditHandler\submissionReview().

& SectionEditorSubmission::getEditorFile ( )

Get post-review file.

Returns
ArticleFile

Definition at line 344 of file SectionEditorSubmission.inc.php.

References DataObject\getData().

SectionEditorSubmission::getEditorFileRevisions (   $round = null)

Get all editor file revisions.

Returns
array ArticleFiles

Definition at line 304 of file SectionEditorSubmission.inc.php.

& SectionEditorSubmission::getGalleys ( )

Get the galleys for an article.

Returns
array ArticleGalley

Definition at line 449 of file SectionEditorSubmission.inc.php.

References DataObject\getData().

SectionEditorSubmission::getHighlightClass ( )
SectionEditorSubmission::getMostRecentCopyeditComment ( )

Get most recent copyedit comment.

Returns
ArticleComment

Definition at line 401 of file SectionEditorSubmission.inc.php.

References DataObject\getData().

SectionEditorSubmission::getMostRecentEditorDecisionComment ( )

Get most recent editor decision comment.

Returns
ArticleComment

Definition at line 385 of file SectionEditorSubmission.inc.php.

References DataObject\getData().

Referenced by getHighlightClass().

SectionEditorSubmission::getMostRecentLayoutComment ( )

Get most recent layout comment.

Returns
ArticleComment

Definition at line 417 of file SectionEditorSubmission.inc.php.

References DataObject\getData().

SectionEditorSubmission::getMostRecentProofreadComment ( )

Get most recent proofread comment.

Returns
ArticleComment

Definition at line 433 of file SectionEditorSubmission.inc.php.

References DataObject\getData().

& SectionEditorSubmission::getRemovedReviewAssignments ( )

Get the IDs of all review assignments removed..

Returns
array int

Definition at line 197 of file SectionEditorSubmission.inc.php.

& SectionEditorSubmission::getReviewAssignments (   $round = null)

Get review assignments for this article.

Returns
array ReviewAssignments

Definition at line 177 of file SectionEditorSubmission.inc.php.

Referenced by getHighlightClass().

& SectionEditorSubmission::getReviewFile ( )

Get review file.

Returns
ArticleFile

Definition at line 287 of file SectionEditorSubmission.inc.php.

References DataObject\getData().

SectionEditorSubmission::getReviewRevision ( )

Get review file revision.

Returns
int

Definition at line 365 of file SectionEditorSubmission.inc.php.

References DataObject\getData().

& SectionEditorSubmission::getRevisedFile ( )

Get revised file for this article.

Returns
ArticleFile

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

References DataObject\getData().

& SectionEditorSubmission::getSubmissionFile ( )

Get submission file for this article.

Returns
ArticleFile

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

References DataObject\getData().

SectionEditorSubmission::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 AuthorSubmission class and changes should be made there as well.

Definition at line 124 of file SectionEditorSubmission.inc.php.

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

& SectionEditorSubmission::getSuppFiles ( )

Get supplementary files for this article.

Returns
array SuppFiles

Definition at line 270 of file SectionEditorSubmission.inc.php.

References DataObject\getData().

SectionEditorSubmission::removeReviewAssignment (   $reviewId)

Remove a review assignment.

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

Definition at line 84 of file SectionEditorSubmission.inc.php.

SectionEditorSubmission::SectionEditorSubmission ( )

Constructor.

Definition at line 42 of file SectionEditorSubmission.inc.php.

SectionEditorSubmission::setAuthorFileRevisions (   $authorFileRevisions,
  $round 
)

Set all author file revisions.

Parameters
$authorFileRevisionsarray ArticleFiles

Definition at line 336 of file SectionEditorSubmission.inc.php.

SectionEditorSubmission::setDecisions (   $editorDecisions,
  $round 
)

Set editor decisions.

Parameters
$editorDecisionsarray
$roundint

Definition at line 224 of file SectionEditorSubmission.inc.php.

SectionEditorSubmission::setEditAssignments (   $editAssignments)

Set edit assignments for this article.

Parameters
$editAssignmentsarray

Definition at line 165 of file SectionEditorSubmission.inc.php.

References DataObject\setData().

SectionEditorSubmission::setEditorFile (   $editorFile)

Set post-review file.

Parameters
$editorFileArticleFile

Definition at line 353 of file SectionEditorSubmission.inc.php.

References DataObject\setData().

SectionEditorSubmission::setEditorFileRevisions (   $editorFileRevisions,
  $round 
)

Set all editor file revisions.

Parameters
$editorFileRevisionsarray ArticleFiles

Definition at line 316 of file SectionEditorSubmission.inc.php.

SectionEditorSubmission::setGalleys ( $galleys)

Set the galleys for an article.

Parameters
$galleysarray ArticleGalley

Definition at line 458 of file SectionEditorSubmission.inc.php.

References DataObject\setData().

SectionEditorSubmission::setMostRecentCopyeditComment (   $mostRecentCopyeditComment)

Set most recent copyedit comment.

Parameters
$mostRecentCopyeditCommentArticleComment

Definition at line 409 of file SectionEditorSubmission.inc.php.

References DataObject\setData().

SectionEditorSubmission::setMostRecentEditorDecisionComment (   $mostRecentEditorDecisionComment)

Set most recent editor decision comment.

Parameters
$mostRecentEditorDecisionCommentArticleComment

Definition at line 393 of file SectionEditorSubmission.inc.php.

References DataObject\setData().

SectionEditorSubmission::setMostRecentLayoutComment (   $mostRecentLayoutComment)

Set most recent layout comment.

Parameters
$mostRecentLayoutCommentArticleComment

Definition at line 425 of file SectionEditorSubmission.inc.php.

References DataObject\setData().

SectionEditorSubmission::setMostRecentProofreadComment (   $mostRecentProofreadComment)

Set most recent proofread comment.

Parameters
$mostRecentProofreadCommentArticleComment

Definition at line 441 of file SectionEditorSubmission.inc.php.

References DataObject\setData().

SectionEditorSubmission::setReviewAssignments (   $reviewAssignments,
  $round 
)

Set review assignments for this article.

Parameters
$reviewAssignmentsarray ReviewAssignments

Definition at line 189 of file SectionEditorSubmission.inc.php.

SectionEditorSubmission::setReviewFile (   $reviewFile)

Set review file.

Parameters
$reviewFileArticleFile

Definition at line 296 of file SectionEditorSubmission.inc.php.

References DataObject\setData().

SectionEditorSubmission::setReviewRevision (   $reviewRevision)

Set review file revision.

Parameters
$reviewRevisionint

Definition at line 373 of file SectionEditorSubmission.inc.php.

References DataObject\setData().

SectionEditorSubmission::setRevisedFile (   $revisedFile)

Set revised file for this article.

Parameters
$submissionFileArticleFile

Definition at line 262 of file SectionEditorSubmission.inc.php.

References DataObject\setData().

SectionEditorSubmission::setSubmissionFile (   $submissionFile)

Set submission file for this article.

Parameters
$submissionFileArticleFile

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

References DataObject\setData().

SectionEditorSubmission::setSuppFiles (   $suppFiles)

Set supplementary file for this article.

Parameters
$suppFilesarray SuppFiles

Definition at line 279 of file SectionEditorSubmission.inc.php.

References DataObject\setData().

SectionEditorSubmission::updateReviewAssignment (   $reviewAssignment)

Updates an existing review assignment.

Parameters
$reviewAssignmentReviewAssignment

Definition at line 101 of file SectionEditorSubmission.inc.php.


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