PaperGalley Class Reference
[Paper]

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

Inheritance diagram for PaperGalley:

List of all members.

Public Member Functions
	getGalleyId ()
	getGalleyLabel ()
	getLabel ()
	getLocale ()
	getSequence ()
	getViews ()
	isDependentFile ($fileId)
	isHTMLGalley ()
	isPdfGalley ()
	PaperGalley ()
	setGalleyId ($galleyId)
	setLabel ($label)
	setLocale ($locale)
	setSequence ($sequence)
	setViews ($views)

---

Detailed Description

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

See also:

PaperGalleyDAO

Definition at line 20 of file PaperGalley.inc.php.

---

Member Function Documentation

PaperGalley.getGalleyId

(

)

Get ID of galley.

Returns:

int

Definition at line 69 of file PaperGalley.inc.php.

Referenced by PaperHTMLGalley.getHTMLContents().

PaperGalley.getGalleyLabel

(

)

Get the localized value of the galley label.

Returns:

$string

Definition at line 104 of file PaperGalley.inc.php.

References getLabel(), AppLocale.getLocale(), and getLocale().

PaperGalley.getLabel

(

)

Get label/title.

Returns:

string

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

Referenced by getGalleyLabel().

PaperGalley.getLocale

(

)

Get locale.

Returns:

string

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

Referenced by getGalleyLabel().

PaperGalley.getSequence

(

)

Get sequence order of supplementary file.

Returns:

float

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

PaperGalley.getViews

(

)

Get views count.

Returns:

int

Definition at line 87 of file PaperGalley.inc.php.

PaperGalley.isDependentFile

(

$

fileId

)

Check if the specified file is a dependent file.

Parameters:

$fileId

int

Returns:

boolean

Reimplemented in PaperHTMLGalley.

Definition at line 57 of file PaperGalley.inc.php.

PaperGalley.isHTMLGalley

(

)

Check if galley is an HTML galley.

Returns:

boolean

Reimplemented in PaperHTMLGalley.

Definition at line 33 of file PaperGalley.inc.php.

PaperGalley.isPdfGalley

(

)

Check if galley is a PDF galley.

Returns:

boolean

Definition at line 41 of file PaperGalley.inc.php.

References PaperFile.getFileType().

PaperGalley.PaperGalley

(

)

Constructor.

Definition at line 25 of file PaperGalley.inc.php.

PaperGalley.setGalleyId

(

$

galleyId

)

Set ID of galley.

Parameters:

$galleyId

int

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

PaperGalley.setLabel

(

$

label

)

Set label/title.

Parameters:

$label

string

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

PaperGalley.setLocale

(

$

locale

)

Set locale.

Parameters:

$locale

string

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

PaperGalley.setSequence

(

$

sequence

)

Set sequence order of supplementary file.

Parameters:

$sequence

float

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

PaperGalley.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 96 of file PaperGalley.inc.php.

---

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

• classes/paper/PaperGalley.inc.php

---