Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
Article Class Reference
Inheritance diagram for Article:
Submission DataObject AuthorSubmission CopyeditorSubmission LayoutEditorSubmission ProofreaderSubmission PublishedArticle ReviewerSubmission SectionEditorSubmission EditorSubmission

Public Member Functions

 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

Article class.

See Also
ArticleDAO

Definition at line 47 of file Article.inc.php.

Member Function Documentation

Article::Article ( )

Constructor.

Definition at line 51 of file Article.inc.php.

References DataObject\setHasLoadableAdapters().

Article::getArticleAbstract ( )

Get "localized" article abstract (if applicable). DEPRECATED in favour of getLocalizedAbstract.

Returns
string

Definition at line 80 of file Article.inc.php.

References Submission\getLocalizedAbstract(), and Config\getVar().

Article::getArticleCoverageChron ( )

Return the localized chronological coverage. DEPRECATED in favour of getLocalizedCoverageChron.

Returns
string

Definition at line 289 of file Article.inc.php.

References Submission\getLocalizedCoverageChron(), and Config\getVar().

Article::getArticleCoverageGeo ( )

Return the localized geographical coverage. DEPRECATED in favour of getLocalizedCoverageGeo.

Returns
string

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

References Submission\getLocalizedCoverageGeo(), and Config\getVar().

Article::getArticleCoverageSample ( )

Return the localized sample coverage. DEPRECATED in favour of getLocalizedCoverageSample.

Returns
string

Definition at line 299 of file Article.inc.php.

References Submission\getLocalizedCoverageSample(), and Config\getVar().

Article::getArticleCoverPageAltText ( )

Get the localized article cover alternate text. DEPRECATED in favour of getLocalizedCoverPageAltText.

Returns
string

Definition at line 369 of file Article.inc.php.

References Submission\getLocalizedCoverPageAltText(), and Config\getVar().

Article::getArticleDiscipline ( )

Return the localized discipline. DEPRECATED in favour of getLocalizedDiscipline.

Returns
string

Definition at line 249 of file Article.inc.php.

References Submission\getLocalizedDiscipline(), and Config\getVar().

Article::getArticleFileName ( )

Get the localized article cover filename. DEPRECATED in favour of getLocalizedFileName.

Returns
string

Definition at line 329 of file Article.inc.php.

References Submission\getLocalizedFileName(), and Config\getVar().

Article::getArticleHeight ( )

Get the localized article cover height. DEPRECATED in favour of getLocalizedHeight.

Returns
string

Definition at line 349 of file Article.inc.php.

References Submission\getLocalizedHeight(), and Config\getVar().

Article::getArticleId ( )

Get ID of article.

Returns
int

Definition at line 93 of file Article.inc.php.

References DataObject\getId(), and Config\getVar().

Referenced by AuthorSubmission\addReviewAssignment().

Article::getArticleOriginalFileName ( )

Get the localized article cover filename on the uploader's computer. DEPRECATED in favour of getLocalizedOriginalFileName.

Returns
string

Definition at line 359 of file Article.inc.php.

References Submission\getLocalizedData(), and Config\getVar().

Article::getArticleShowCoverPage ( )

Get the flag indicating whether or not to show an article cover page. DEPRECATED in favour of getLocalizedShowCoverPage.

Returns
string

Definition at line 380 of file Article.inc.php.

References Submission\getLocalizedShowCoverPage(), and Config\getVar().

Article::getArticleSponsor ( )

Return the localized sponsor. DEPRECATED in favour of getLocalizedSponsor.

Returns
string

Definition at line 319 of file Article.inc.php.

References Submission\getLocalizedSponsor(), and Config\getVar().

Article::getArticleSubject ( )

Return the localized subject. DEPRECATED in favour of getLocalizedSubject.

Returns
string

Definition at line 269 of file Article.inc.php.

References Submission\getLocalizedSubject(), and Config\getVar().

Article::getArticleSubjectClass ( )

Return the localized subject classification. DEPRECATED in favour of getLocalizedSubjectClass.

Returns
string

Definition at line 259 of file Article.inc.php.

References Submission\getLocalizedSubjectClass(), and Config\getVar().

Article::getArticleTitle ( )

Get "localized" article title (if applicable). DEPRECATED in favour of getLocalizedTitle.

Returns
string

Definition at line 70 of file Article.inc.php.

References Submission\getLocalizedTitle(), and Config\getVar().

Article::getArticleType ( )

Return the localized type (method/approach). DEPRECATED in favour of getLocalizedType.

Returns
string

Definition at line 309 of file Article.inc.php.

References Submission\getLocalizedType(), and Config\getVar().

Article::getArticleWidth ( )

Get the localized article cover width. DEPRECATED in favour of getLocalizedWidth.

Returns
string

Definition at line 339 of file Article.inc.php.

References Submission\getLocalizedWidth(), and Config\getVar().

Article::getAssociatedUserIds (   $authors = true,
  $reviewers = true,
  $editors = true,
  $proofreader = true,
  $copyeditor = true,
  $layoutEditor = true 
)

Get an array of user IDs associated with this article

Parameters
$authorsboolean
$reviewersboolean
$editorsboolean
$proofreaderboolean
$copyeditorboolean
$layoutEditorboolean
Returns
array User IDs

Definition at line 526 of file Article.inc.php.

References DAORegistry\getDAO(), DataObject\getId(), and Submission\getUserId().

Article::getAssocType ( )
See Also
Submission::getAssocType()

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

Article::getBestArticleId (   $journal = null)

Return the "best" article ID – If a public article ID is set, use it; otherwise use the internal article Id. (Checks the journal settings to ensure that the public ID feature is enabled.)

Parameters
$journalObject the journal this article is in
Returns
string

Definition at line 114 of file Article.inc.php.

References DAORegistry\getDAO(), DataObject\getId(), and getJournalId().

& Article::getCommentsStatusOptions ( )

Get an associative array matching RT comments status codes with locale strings.

Returns
array comments status => localeString

Definition at line 507 of file Article.inc.php.

Referenced by SubmissionEditHandler\submission().

Article::getCommentsStatusString ( )

Return locale string corresponding to RT comments status.

Returns
string

Definition at line 469 of file Article.inc.php.

References Submission\getCommentsStatus().

Article::getCommentsToEditor ( )

Get comments to editor.

Returns
string

Definition at line 389 of file Article.inc.php.

References DataObject\getData().

Article::getCurrentRound ( )

Get current review round.

Returns
int

Definition at line 405 of file Article.inc.php.

References DataObject\getData().

Referenced by SectionEditorSubmission\getHighlightClass().

Article::getEditorFileId ( )

Get editor file id.

Returns
int

Definition at line 421 of file Article.inc.php.

References DataObject\getData().

Article::getEnableComments ( )

Return boolean indicating if article RT comments should be enabled. Checks both the section and article comments status. Article status overrides section status.

Returns
int

Definition at line 486 of file Article.inc.php.

References Submission\getCommentsStatus(), DAORegistry\getDAO(), getJournalId(), and getSectionId().

Article::getFastTracked ( )

get expedited

Returns
boolean

Definition at line 437 of file Article.inc.php.

References DataObject\getData().

& Article::getFileBySignoffType (   $signoffType,
  $idOnly = false 
)

Get the file for this article at a given signoff stage

Parameters
$signoffTypestring
$idOnlyboolean Return only file ID
Returns
ArticleFile

Definition at line 594 of file Article.inc.php.

References DAORegistry\getDAO(), and DataObject\getId().

Article::getHideAuthor ( )

Return option selection indicating if author should be hidden in issue ToC.

Returns
int AUTHOR_TOC_...

Definition at line 453 of file Article.inc.php.

References DataObject\getData().

Article::getJournalId ( )

Get ID of journal.

Returns
int

Definition at line 162 of file Article.inc.php.

References DataObject\getData().

Referenced by getBestArticleId(), getEnableComments(), and SectionEditorSubmission\getHighlightClass().

Article::getSectionAbbrev ( )

Get section abbreviation.

Returns
string

Definition at line 232 of file Article.inc.php.

References DataObject\getData().

Article::getSectionId ( )

Get ID of article's section.

Returns
int

Definition at line 178 of file Article.inc.php.

References DataObject\getData().

Referenced by getEnableComments().

Article::getSectionTitle ( )

Get title of article's section.

Returns
string

Definition at line 216 of file Article.inc.php.

References DataObject\getData().

Article::getSignoff (   $signoffType)

Get the signoff for this article

Parameters
$signoffTypestring
Returns
Signoff

Definition at line 583 of file Article.inc.php.

References DAORegistry\getDAO(), and DataObject\getId().

Article::getStoredPubId (   $pubIdType)

Get stored public ID of the submission.

Parameters
$pubIdTypestring 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).
Returns
int

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

References DataObject\getData().

& Article::getUserBySignoffType (   $signoffType)

Get the user associated with a given signoff and this article

Parameters
$signoffTypestring
Returns
User

Definition at line 618 of file Article.inc.php.

References DAORegistry\getDAO(), and DataObject\getId().

Article::getUserIdBySignoffType (   $signoffType)

Get the user id associated with a given signoff and this article

Parameters
$signoffTypestring
Returns
int

Definition at line 637 of file Article.inc.php.

References DAORegistry\getDAO(), and DataObject\getId().

Article::setArticleId (   $articleId)

Set ID of article.

Parameters
$articleIdint

Definition at line 102 of file Article.inc.php.

References Config\getVar(), and DataObject\setId().

Article::setCommentsToEditor (   $commentsToEditor)

Set comments to editor.

Parameters
$commentsToEditorstring

Definition at line 397 of file Article.inc.php.

References DataObject\setData().

Article::setCurrentRound (   $currentRound)

Set current review round.

Parameters
$currentRoundint

Definition at line 413 of file Article.inc.php.

References DataObject\setData().

Article::setEditorFileId (   $editorFileId)

Set editor file id.

Parameters
$editorFileIdint

Definition at line 429 of file Article.inc.php.

References DataObject\setData().

Article::setFastTracked (   $fastTracked)

set fastTracked

Parameters
$fastTrackedboolean

Definition at line 445 of file Article.inc.php.

References DataObject\setData().

Article::setHideAuthor (   $hideAuthor)

Set option selection indicating if author should be hidden in issue ToC.

Parameters
$hideAuthorint AUTHOR_TOC_...

Definition at line 461 of file Article.inc.php.

References DataObject\setData().

Article::setJournalId (   $journalId)

Set ID of journal.

Parameters
$journalIdint

Definition at line 170 of file Article.inc.php.

References DataObject\setData().

Article::setSectionAbbrev (   $sectionAbbrev)

Set section abbreviation.

Parameters
$sectionAbbrevstring

Definition at line 240 of file Article.inc.php.

References DataObject\setData().

Article::setSectionId (   $sectionId)

Set ID of article's section.

Parameters
$sectionIdint

Definition at line 186 of file Article.inc.php.

References DataObject\setData().

Article::setSectionTitle (   $sectionTitle)

Set title of article's section.

Parameters
$sectionTitlestring

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

References DataObject\setData().

Article::setStoredPubId (   $pubIdType,
  $pubId 
)

Set the stored public ID of the submission.

Parameters
$pubIdTypestring 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).
$pubIdstring

Definition at line 208 of file Article.inc.php.

References DataObject\setData().


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