PublishedArticle Class Reference
[Article]

Published article class. More...

Inheritance diagram for PublishedArticle:

List of all members.

Public Member Functions
	getAccessStatus ()
	getArticleId ()
	getBestArticleId ($journal=null)
	getDatePublished ()
	getDOI ()
&	getGalleys ()
	getIssueId ()
&	getLocalizedGalleys ()
	getPubId ()
	getPublicArticleId ()
	getSectionId ()
	getSeq ()
&	getSuppFiles ()
	getViews ()
	PublishedArticle ()
	setAccessStatus ($accessStatus)
	setArticleId ($articleId)
	setDatePublished ($datePublished)
	setGalleys (&$galleys)
	setIssueId ($issueId)
	setPubId ($pubId)
	setPublicArticleId ($publicArticleId)
	setSectionId ($sectionId)
	setSeq ($seq)
	setSuppFiles ($suppFiles)
	setViews ($views)

---

Detailed Description

Published article class.

See also:

PublishedArticleDAO

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

---

Member Function Documentation

PublishedArticle.getAccessStatus

(

)

get access status

Returns:

int

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

References DataObject.getData().

PublishedArticle.getArticleId

(

)

Get ID of associated article.

Returns:

int

Reimplemented from Article.

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

References DataObject.getData().

Referenced by getBestArticleId(), and getDOI().

PublishedArticle.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:

$journal

Object the journal this article is in

Returns:

string

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

References getArticleId(), DAORegistry.getDAO(), Article.getJournalId(), and getPublicArticleId().

PublishedArticle.getDatePublished

(

)

Get date published.

Returns:

date

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

References DataObject.getData().

PublishedArticle.getDOI

(

)

Get a DOI for this article.

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

References getArticleId(), DAORegistry.getDAO(), Request.getJournal(), and Article.getJournalId().

& PublishedArticle.getGalleys

(

)

Get the galleys for an article.

Returns:

array ArticleGalley

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

References DataObject.getData().

PublishedArticle.getIssueId

(

)

Get ID of the issue this article is in.

Returns:

int

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

References DataObject.getData().

& PublishedArticle.getLocalizedGalleys

(

)

Get the localized galleys for an article.

Returns:

array ArticleGalley

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

References HookRegistry.call(), DataObject.getData(), Locale.getLocale(), and Locale.getPrimaryLocale().

PublishedArticle.getPubId

(

)

Get ID of published article.

Returns:

int

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

References DataObject.getData().

PublishedArticle.getPublicArticleId

(

)

Get public article id

Returns:

string

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

References DataObject.getData().

Referenced by getBestArticleId().

PublishedArticle.getSectionId

(

)

Get section ID of the issue this article is in.

Returns:

int

Reimplemented from Article.

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

References DataObject.getData().

PublishedArticle.getSeq

(

)

Get sequence of article in table of contents.

Returns:

float

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

References DataObject.getData().

& PublishedArticle.getSuppFiles

(

)

Get supplementary files for this article.

Returns:

array SuppFiles

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

References DataObject.getData().

PublishedArticle.getViews

(

)

Get views of the published article.

Returns:

int

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

References DataObject.getData().

PublishedArticle.PublishedArticle

(

)

Constructor.

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

PublishedArticle.setAccessStatus

(

$

accessStatus

)

set access status

Parameters:

$accessStatus

int

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

References DataObject.setData().

PublishedArticle.setArticleId

(

$

articleId

)

Set ID of associated article.

Parameters:

$articleId

int

Reimplemented from Article.

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

References DataObject.setData().

PublishedArticle.setDatePublished

(

$

datePublished

)

Set date published.

Parameters:

$datePublished

date

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

PublishedArticle.setGalleys

(

&$

galleys

)

Set the galleys for an article.

Parameters:

$galleys

array ArticleGalley

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

References DataObject.setData().

PublishedArticle.setIssueId

(

$

issueId

)

Set ID of the issue this article is in.

Parameters:

$issueId

int

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

References DataObject.setData().

PublishedArticle.setPubId

(

$

pubId

)

Set ID of published article.

Parameters:

$pubId

int

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

References DataObject.setData().

PublishedArticle.setPublicArticleId

(

$

publicArticleId

)

Set public article id

Parameters:

$publicArticleId

string

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

References DataObject.setData().

PublishedArticle.setSectionId

(

$

sectionId

)

Set section ID of the issue this article is in.

Parameters:

$sectionId

int

Reimplemented from Article.

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

References DataObject.setData().

PublishedArticle.setSeq

(

$

seq

)

Set sequence of article in table of contents.

Parameters:

$sequence

float

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

References DataObject.setData().

PublishedArticle.setSuppFiles

(

$

suppFiles

)

Set supplementary file for this article.

Parameters:

$suppFiles

array SuppFiles

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

References DataObject.setData().

PublishedArticle.setViews

(

$

views

)

Set views of the published article.

Parameters:

$views

int

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

References DataObject.setData().

---

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

• classes/article/PublishedArticle.inc.php