Open Journal Systems  2.4.4
 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

 _getLicenseFieldValue ($locale, $field, $preview=false)
 
 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 ()
 
 getCopyrightHolder ($locale, $preview=false)
 
 getCopyrightYear ($preview=false)
 
 getCurrentRound ()
 
 getEditorFileId ()
 
 getEnableComments ()
 
 getEndingPage ()
 
 getFastTracked ()
 
getFileBySignoffType ($signoffType, $idOnly=false)
 
 getHideAuthor ()
 
 getJournalId ()
 
 getLicenseUrl ($preview=false)
 
 getLocalizedCopyrightHolder ($preview=false)
 
 getSectionAbbrev ()
 
 getSectionId ()
 
 getSectionTitle ()
 
 getSignoff ($signoffType)
 
 getStartingPage ()
 
 getStoredCopyrightHolder ($locale)
 
 getStoredCopyrightYear ()
 
 getStoredLicenseURL ()
 
 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)
 
 setStoredCopyrightHolder ($copyrightHolder, $locale)
 
 setStoredCopyrightYear ($copyrightYear)
 
 setStoredLicenseURL ($licenseUrl)
 
 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 52 of file Article.inc.php.

Member Function Documentation

Article::_getLicenseFieldValue (   $locale,
  $field,
  $preview = false 
)

Get a license field for this article, attaching it from journal settings as necessary.

Parameters
$localestring Locale
$fieldint PERMISSIONS_FIELD_... Which to return
$previewboolean If true, preview the license; do not attach

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

References Submission\getAuthorString(), DAORegistry\getDAO(), getJournalId(), getStoredCopyrightHolder(), getStoredCopyrightYear(), getStoredLicenseURL(), setStoredCopyrightHolder(), setStoredCopyrightYear(), and setStoredLicenseURL().

Referenced by getCopyrightHolder(), getCopyrightYear(), and getLicenseUrl().

Article::Article ( )

Constructor.

Definition at line 56 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 85 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 458 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 448 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 468 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 538 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 418 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 498 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 518 of file Article.inc.php.

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

Article::getArticleId ( )

Get ID of article.

Returns
int

Definition at line 98 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 528 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 549 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 488 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 438 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 428 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 75 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 478 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 508 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 695 of file Article.inc.php.

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

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

Definition at line 66 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 119 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 676 of file Article.inc.php.

Referenced by SubmissionEditHandler\submission().

Article::getCommentsStatusString ( )

Return locale string corresponding to RT comments status.

Returns
string

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

References Submission\getCommentsStatus().

Article::getCommentsToEditor ( )

Get comments to editor.

Returns
string

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

References DataObject\getData().

Article::getCopyrightHolder (   $locale,
  $preview = false 
)

Get the copyright holder for this article, attaching it from journal settings as necessary.

Parameters
$localestring Locale
$previewboolean If true, preview the license; do not attach

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

References _getLicenseFieldValue().

Referenced by getLocalizedCopyrightHolder().

Article::getCopyrightYear (   $preview = false)

Get the copyright year for this article, attaching it as necessary

Parameters
$previewboolean If true, preview the license; do not attach

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

References _getLicenseFieldValue().

Article::getCurrentRound ( )

Get current review round.

Returns
int

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

References DataObject\getData().

Referenced by SectionEditorSubmission\getHighlightClass().

Article::getEditorFileId ( )

Get editor file id.

Returns
int

Definition at line 590 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 655 of file Article.inc.php.

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

Article::getEndingPage ( )

Get ending page of an article.

Returns
int

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

References Submission\getPages().

Article::getFastTracked ( )

get expedited

Returns
boolean

Definition at line 606 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 763 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 622 of file Article.inc.php.

References DataObject\getData().

Article::getJournalId ( )

Get ID of journal.

Returns
int

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

References DataObject\getData().

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

Article::getLicenseUrl (   $preview = false)

Get the license URL for this article, attaching it from journal settings as necessary.

Parameters
$previewboolean If true, preview the license; do not attach

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

References _getLicenseFieldValue().

Article::getLocalizedCopyrightHolder (   $preview = false)

Get the localized copyright holder for this article, attaching it from journal settings as necessary.

Parameters
$previewboolean If true, preview the license; do not attach

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

References getCopyrightHolder(), and AppLocale\getLocalePrecedence().

Article::getSectionAbbrev ( )

Get section abbreviation.

Returns
string

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

References DataObject\getData().

Article::getSectionId ( )

Get ID of article's section.

Returns
int

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

References DataObject\getData().

Referenced by getEnableComments().

Article::getSectionTitle ( )

Get title of article's section.

Returns
string

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

References DataObject\getData().

Article::getSignoff (   $signoffType)

Get the signoff for this article

Parameters
$signoffTypestring
Returns
Signoff

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

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

Article::getStartingPage ( )

Get starting page of an article.

Returns
int

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

References Submission\getPages().

Article::getStoredCopyrightHolder (   $locale)

Get stored copyright holder for the submission.

Parameters
$localestring locale
Returns
string

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

References DataObject\getData().

Referenced by _getLicenseFieldValue().

Article::getStoredCopyrightYear ( )

Get stored copyright year for the submission.

Returns
string

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

References DataObject\getData().

Referenced by _getLicenseFieldValue().

Article::getStoredLicenseURL ( )

Get stored license URL for the submission content.

Returns
string

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

References DataObject\getData().

Referenced by _getLicenseFieldValue().

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 316 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 787 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 806 of file Article.inc.php.

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

Article::setArticleId (   $articleId)

Set ID of article.

Parameters
$articleIdint

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

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

Article::setCommentsToEditor (   $commentsToEditor)

Set comments to editor.

Parameters
$commentsToEditorstring

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

References DataObject\setData().

Article::setCurrentRound (   $currentRound)

Set current review round.

Parameters
$currentRoundint

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

References DataObject\setData().

Article::setEditorFileId (   $editorFileId)

Set editor file id.

Parameters
$editorFileIdint

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

References DataObject\setData().

Article::setFastTracked (   $fastTracked)

set fastTracked

Parameters
$fastTrackedboolean

Definition at line 614 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 630 of file Article.inc.php.

References DataObject\setData().

Article::setJournalId (   $journalId)

Set ID of journal.

Parameters
$journalIdint

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

References DataObject\setData().

Article::setSectionAbbrev (   $sectionAbbrev)

Set section abbreviation.

Parameters
$sectionAbbrevstring

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

References DataObject\setData().

Article::setSectionId (   $sectionId)

Set ID of article's section.

Parameters
$sectionIdint

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

References DataObject\setData().

Article::setSectionTitle (   $sectionTitle)

Set title of article's section.

Parameters
$sectionTitlestring

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

References DataObject\setData().

Article::setStoredCopyrightHolder (   $copyrightHolder,
  $locale 
)

Set the stored copyright holder for the submission.

Parameters
$copyrightHolderstring Copyright holder
$localestring locale

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

References DataObject\setData().

Referenced by _getLicenseFieldValue().

Article::setStoredCopyrightYear (   $copyrightYear)

Set the stored copyright year for the submission.

Parameters
$copyrightYearstring Copyright holder

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

References DataObject\setData().

Referenced by _getLicenseFieldValue().

Article::setStoredLicenseURL (   $licenseUrl)

Set the stored license URL for the submission content.

Parameters
$licensestring License of submission content

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

References DataObject\setData().

Referenced by _getLicenseFieldValue().

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 327 of file Article.inc.php.

References DataObject\setData().


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