ArticleGalley Class Reference
[Article]

A galley is a final presentation version of the full-text of an article. More...

Inheritance diagram for ArticleGalley:

List of all members.

Public Member Functions
	ArticleGalley ()
	getBestGalleyId (&$journal)
	getGalleyId ()
	getGalleyLabel ()
	getLabel ()
	getLocale ()
	getPublicGalleyId ()
	getSequence ()
	getViews ()
	isDependentFile ($fileId)
	isHTMLGalley ()
	isPdfGalley ()
	setGalleyId ($galleyId)
	setLabel ($label)
	setLocale ($locale)
	setPublicGalleyId ($publicGalleyId)
	setSequence ($sequence)
	setViews ($views)

---

Detailed Description

A galley is a final presentation version of the full-text of an article.

See also:

ArticleGalleyDAO

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

---

Member Function Documentation

ArticleGalley.ArticleGalley

(

)

Constructor.

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

ArticleGalley.getBestGalleyId

(

&$

journal

)

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 galley is in

Returns:

string

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

References getGalleyId(), and getPublicGalleyId().

Referenced by ArticleXMLGalley.getHTMLContents(), and ArticleHTMLGalley.getHTMLContents().

ArticleGalley.getGalleyId

(

)

Get ID of galley.

Returns:

int

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

References DataObject.getData().

Referenced by getBestGalleyId(), ArticleXMLGalley.getHTMLContents(), and ArticleXMLGalley.viewFileContents().

ArticleGalley.getGalleyLabel

(

)

Get the localized value of the galley label.

Returns:

$string

Definition at line 103 of file ArticleGalley.inc.php.

References Locale.getAllLocales(), getLabel(), Locale.getLocale(), and getLocale().

ArticleGalley.getLabel

(

)

Get label/title.

Returns:

string

Definition at line 116 of file ArticleGalley.inc.php.

References DataObject.getData().

Referenced by getGalleyLabel().

ArticleGalley.getLocale

(

)

Get locale.

Returns:

string

Definition at line 132 of file ArticleGalley.inc.php.

References DataObject.getData().

Referenced by getGalleyLabel().

ArticleGalley.getPublicGalleyId

(

)

Get public galley id

Returns:

string

Definition at line 164 of file ArticleGalley.inc.php.

References DataObject.getData().

Referenced by getBestGalleyId().

ArticleGalley.getSequence

(

)

Get sequence order of supplementary file.

Returns:

float

Definition at line 148 of file ArticleGalley.inc.php.

References DataObject.getData().

ArticleGalley.getViews

(

)

Get views count.

Returns:

int

Definition at line 86 of file ArticleGalley.inc.php.

References DataObject.getData().

ArticleGalley.isDependentFile

(

$

fileId

)

Check if the specified file is a dependent file.

Parameters:

$fileId

int

Returns:

boolean

Reimplemented in ArticleHTMLGalley.

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

ArticleGalley.isHTMLGalley

(

)

Check if galley is an HTML galley.

Returns:

boolean

Reimplemented in ArticleHTMLGalley, and ArticleXMLGalley.

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

ArticleGalley.isPdfGalley

(

)

Check if galley is a PDF galley.

Returns:

boolean

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

References ArticleFile.getFileType().

Referenced by ArticleXMLGalley._xsltCacheMiss().

ArticleGalley.setGalleyId

(

$

galleyId

)

Set ID of galley.

Parameters:

$galleyId

int

Definition at line 78 of file ArticleGalley.inc.php.

References DataObject.setData().

ArticleGalley.setLabel

(

$

label

)

Set label/title.

Parameters:

$label

string

Definition at line 124 of file ArticleGalley.inc.php.

References DataObject.setData().

ArticleGalley.setLocale

(

$

locale

)

Set locale.

Parameters:

$locale

string

Definition at line 140 of file ArticleGalley.inc.php.

References DataObject.setData().

ArticleGalley.setPublicGalleyId

(

$

publicGalleyId

)

Set public galley id

Parameters:

$publicGalleyId

string

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

References DataObject.setData().

ArticleGalley.setSequence

(

$

sequence

)

Set sequence order of supplementary file.

Parameters:

$sequence

float

Definition at line 156 of file ArticleGalley.inc.php.

References DataObject.setData().

ArticleGalley.setViews

(

$

views

)

Set views count. NOTE that the views count is NOT stored by the DAO update or insert functions.

Parameters:

$views

int

Definition at line 95 of file ArticleGalley.inc.php.

References DataObject.setData().

---

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

• classes/article/ArticleGalley.inc.php