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

 _getDefaultLicenseFieldValue ($locale, $field)
 
 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)
 
 getCopyrightYear ()
 
 getCurrentRound ()
 
 getDefaultCopyrightHolder ($locale)
 
 getDefaultCopyrightYear ()
 
 getDefaultLicenseUrl ()
 
 getEditorFileId ()
 
 getEnableComments ()
 
 getEndingPage ()
 
 getFastTracked ()
 
getFileBySignoffType ($signoffType, $idOnly=false)
 
 getHideAuthor ()
 
 getJournalId ()
 
 getLicenseURL ()
 
 getLocalizedCopyrightHolder ($preferredLocale=null)
 
 getSectionAbbrev ()
 
 getSectionId ()
 
 getSectionTitle ()
 
 getSignoff ($signoffType)
 
 getStartingPage ()
 
 getStoredPubId ($pubIdType)
 
getUserBySignoffType ($signoffType)
 
 getUserIdBySignoffType ($signoffType)
 
 initializePermissions ()
 
 isCCLicense ()
 
 setArticleId ($articleId)
 
 setCommentsToEditor ($commentsToEditor)
 
 setCopyrightHolder ($copyrightHolder, $locale)
 
 setCopyrightYear ($copyrightYear)
 
 setCurrentRound ($currentRound)
 
 setEditorFileId ($editorFileId)
 
 setFastTracked ($fastTracked)
 
 setHideAuthor ($hideAuthor)
 
 setJournalId ($journalId)
 
 setLicenseURL ($licenseUrl)
 
 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 52 of file Article.inc.php.

Member Function Documentation

Article::_getDefaultLicenseFieldValue (   $locale,
  $field 
)

Get the best guess license field for this article. Return the existing value if the field is already set, otherwise calculate a best value based on the Journal Settings.

Parameters
$localestring Locale
$fieldint PERMISSIONS_FIELD_... Which to return

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

References Submission\getAuthorString(), getCopyrightHolder(), getCopyrightYear(), DAORegistry\getDAO(), DataObject\getId(), getJournalId(), and getLicenseURL().

Referenced by getDefaultCopyrightHolder(), getDefaultCopyrightYear(), and getDefaultLicenseUrl().

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 468 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 458 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 478 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 548 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 428 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 508 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 528 of file Article.inc.php.

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

Article::getArticleId ( )

Get ID of article. DEPRECATED in favor of getId()

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 538 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 559 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 498 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 448 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 438 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 488 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 518 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 705 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 686 of file Article.inc.php.

Referenced by SubmissionEditHandler\submission().

Article::getCommentsStatusString ( )

Return locale string corresponding to RT comments status.

Returns
string

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

References Submission\getCommentsStatus().

Article::getCommentsToEditor ( )

Get comments to editor.

Returns
string

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

References DataObject\getData().

Article::getCopyrightHolder (   $locale)

Get stored copyright holder for the submission.

Parameters
$localestring locale
Returns
string

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

References DataObject\getData().

Referenced by _getDefaultLicenseFieldValue().

Article::getCopyrightYear ( )

Get stored copyright year for the submission.

Returns
string

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

References DataObject\getData().

Referenced by _getDefaultLicenseFieldValue().

Article::getCurrentRound ( )

Get current review round.

Returns
int

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

References DataObject\getData().

Referenced by SectionEditorSubmission\getHighlightClass().

Article::getDefaultCopyrightHolder (   $locale)

Get the copyright holder for this article.

Parameters
$localestring Locale

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

References _getDefaultLicenseFieldValue().

Referenced by initializePermissions().

Article::getDefaultCopyrightYear ( )

Get the copyright year for this article.

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

References _getDefaultLicenseFieldValue().

Referenced by initializePermissions().

Article::getDefaultLicenseUrl ( )

Get the license URL for this article.

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

References _getDefaultLicenseFieldValue().

Article::getEditorFileId ( )

Get editor file id.

Returns
int

Definition at line 600 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 665 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 838 of file Article.inc.php.

References Submission\getPages().

Article::getFastTracked ( )

get expedited

Returns
boolean

Definition at line 616 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 773 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 632 of file Article.inc.php.

References DataObject\getData().

Article::getJournalId ( )

Get ID of journal.

Returns
int

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

References DataObject\getData().

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

Article::getLicenseURL ( )

Get stored license URL for the submission content.

Returns
string

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

References DataObject\getData().

Referenced by _getDefaultLicenseFieldValue(), and isCCLicense().

Article::getLocalizedCopyrightHolder (   $preferredLocale = null)

Get the localized copyright holder for this article.

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

References Submission\getLocalizedData().

Article::getSectionAbbrev ( )

Get section abbreviation.

Returns
string

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

References DataObject\getData().

Article::getSectionId ( )

Get ID of article's section.

Returns
int

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

References DataObject\getData().

Referenced by getEnableComments().

Article::getSectionTitle ( )

Get title of article's section.

Returns
string

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

References DataObject\getData().

Article::getSignoff (   $signoffType)

Get the signoff for this article

Parameters
$signoffTypestring
Returns
Signoff

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

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

Article::getStartingPage ( )

Get starting page of an article.

Returns
int

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

References Submission\getPages().

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 326 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 797 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 816 of file Article.inc.php.

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

Article::initializePermissions ( )

Initialize the copyright and license metadata for an article. This should be called at creation and at publication, to setup license/copyright holder and copyright year, respectively. This depends on the permissions configuration in Journal Setup, and (potentially) on the authors of a article being populated. Only initializes empty fields because of the getDefault...() behaviour, so subsequent calls are safe.

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

References getDefaultCopyrightHolder(), getDefaultCopyrightYear(), Submission\getStatus(), setCopyrightHolder(), setCopyrightYear(), and setLicenseURL().

Article::isCCLicense ( )

Determines whether or not the license for copyright on this Article is a Creative Commons license or not.

Returns
boolean

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

References getLicenseURL().

Article::setArticleId (   $articleId)

Set ID of article. DEPRECATED in favor of setId($id)

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

References DataObject\setData().

Article::setCopyrightHolder (   $copyrightHolder,
  $locale 
)

Set the stored copyright holder for the submission.

Parameters
$copyrightHolderstring Copyright holder
$localestring locale

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

References DataObject\setData().

Referenced by initializePermissions().

Article::setCopyrightYear (   $copyrightYear)

Set the stored copyright year for the submission.

Parameters
$copyrightYearstring Copyright holder

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

References DataObject\setData().

Referenced by initializePermissions().

Article::setCurrentRound (   $currentRound)

Set current review round.

Parameters
$currentRoundint

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

References DataObject\setData().

Article::setEditorFileId (   $editorFileId)

Set editor file id.

Parameters
$editorFileIdint

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

References DataObject\setData().

Article::setFastTracked (   $fastTracked)

set fastTracked

Parameters
$fastTrackedboolean

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

References DataObject\setData().

Article::setJournalId (   $journalId)

Set ID of journal.

Parameters
$journalIdint

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

References DataObject\setData().

Article::setLicenseURL (   $licenseUrl)

Set the stored license URL for the submission content.

Parameters
$licensestring License of submission content

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

References DataObject\setData().

Referenced by initializePermissions().

Article::setSectionAbbrev (   $sectionAbbrev)

Set section abbreviation.

Parameters
$sectionAbbrevstring

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

References DataObject\setData().

Article::setSectionId (   $sectionId)

Set ID of article's section.

Parameters
$sectionIdint

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

References DataObject\setData().

Article::setSectionTitle (   $sectionTitle)

Set title of article's section.

Parameters
$sectionTitlestring

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

References DataObject\setData().


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