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

Public Member Functions

 getAccessStatus ()
 
 getDatePublished ()
 
getGalleys ()
 
 getIssueId ()
 
getLocalizedGalleys ()
 
 getPublishedArticleId ()
 
 getSectionId ()
 
 getSeq ()
 
getSuppFiles ()
 
 getViews ()
 
 PublishedArticle ()
 
 setAccessStatus ($accessStatus)
 
 setDatePublished ($datePublished)
 
 setGalleys (&$galleys)
 
 setIssueId ($issueId)
 
 setPublishedArticleId ($publishedArticleId)
 
 setSectionId ($sectionId)
 
 setSeq ($seq)
 
 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

Published article class.

See Also
PublishedArticleDAO

Definition at line 23 of file PublishedArticle.inc.php.

Member Function Documentation

PublishedArticle::getAccessStatus ( )

get access status (ARTICLE_ACCESS_...)

Returns
int

Definition at line 126 of file PublishedArticle.inc.php.

References DataObject\getData().

PublishedArticle::getDatePublished ( )

Get date published.

Returns
date

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

References DataObject\getData().

& PublishedArticle::getGalleys ( )

Get the galleys for an article.

Returns
array ArticleGalley

Definition at line 142 of file PublishedArticle.inc.php.

References DataObject\getData().

PublishedArticle::getIssueId ( )

Get ID of the issue this article is in.

Returns
int

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

References DataObject\getData().

& PublishedArticle::getLocalizedGalleys ( )

Get the localized galleys for an article.

Returns
array ArticleGalley

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

References HookRegistry\call(), DataObject\getData(), AppLocale\getLocale(), Submission\getLocale(), and AppLocale\getPrimaryLocale().

PublishedArticle::getPublishedArticleId ( )

Get ID of published article.

Returns
int

Definition at line 36 of file PublishedArticle.inc.php.

References DataObject\getData().

PublishedArticle::getSectionId ( )

Get section ID of the issue this article is in.

Returns
int

Definition at line 68 of file PublishedArticle.inc.php.

References DataObject\getData().

PublishedArticle::getSeq ( )

Get sequence of article in table of contents.

Returns
float

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

References DataObject\getData().

& PublishedArticle::getSuppFiles ( )

Get supplementary files for this article.

Returns
array SuppFiles

Definition at line 183 of file PublishedArticle.inc.php.

References DataObject\getData().

PublishedArticle::getViews ( )

Get views of the published article.

Returns
int

Definition at line 117 of file PublishedArticle.inc.php.

References PKPApplication\getApplication(), and DataObject\getId().

PublishedArticle::PublishedArticle ( )

Constructor.

Definition at line 28 of file PublishedArticle.inc.php.

PublishedArticle::setAccessStatus (   $accessStatus)

set access status (ARTICLE_ACCESS_...)

Parameters
$accessStatusint

Definition at line 134 of file PublishedArticle.inc.php.

References DataObject\setData().

PublishedArticle::setDatePublished (   $datePublished)

Set date published.

Parameters
$datePublisheddate

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

PublishedArticle::setGalleys ( $galleys)

Set the galleys for an article.

Parameters
$galleysarray ArticleGalley

Definition at line 175 of file PublishedArticle.inc.php.

References DataObject\setData().

PublishedArticle::setIssueId (   $issueId)

Set ID of the issue this article is in.

Parameters
$issueIdint

Definition at line 60 of file PublishedArticle.inc.php.

References DataObject\setData().

PublishedArticle::setPublishedArticleId (   $publishedArticleId)

Set ID of published article.

Parameters
$publishedArticleIdint

Definition at line 44 of file PublishedArticle.inc.php.

References DataObject\setData().

PublishedArticle::setSectionId (   $sectionId)

Set section ID of the issue this article is in.

Parameters
$sectionIdint

Definition at line 76 of file PublishedArticle.inc.php.

References DataObject\setData().

PublishedArticle::setSeq (   $seq)

Set sequence of article in table of contents.

Parameters
$sequencefloat

Definition at line 109 of file PublishedArticle.inc.php.

References DataObject\setData().

PublishedArticle::setSuppFiles (   $suppFiles)

Set supplementary file for this article.

Parameters
$suppFilesarray SuppFiles

Definition at line 192 of file PublishedArticle.inc.php.

References DataObject\setData().


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