IssueGalley Class Reference

Inheritance diagram for IssueGalley:

Public Member Functions
	getBestGalleyId ()
	getFile ()
	getFileId ()
	getGalleyLabel ()
	getLabel ()
	getLocale ()
	getSequence ()
	getStoredPubId ($pubIdType)
	getViews ()
	isPdfGalley ()
	setFileId ($fileId)
	setLabel ($label)
	setLocale ($locale)
	setSequence ($sequence)
	setStoredPubId ($pubIdType, $pubId)
Public Member Functions inherited from IssueFile
	getContentType ()
	getDateModified ()
	getIssueId ()
	setContentType ($contentType)
	setDateModified ($dateModified)
	setIssueId ($issueId)
Public Member Functions inherited from PKPFile
	getDateUploaded ()
	getFilePath ()
	getFileSize ()
	getFileType ()
	getNiceFileSize ()
	getOriginalFileName ()
	getServerFileName ()
	setDateUploaded ($dateUploaded)
	setFileSize ($fileSize)
	setFileType ($fileType)
	setOriginalFileName ($originalFileName)
	setServerFileName ($fileName)
Public Member Functions inherited from DataObject
	__construct ()
	addSupportedMetadataAdapter ($metadataAdapter)
	extractMetadata ($metadataSchema)
	getAdditionalMetadataFieldNames ()
&	getAllData ()
	getDAO ()
&	getData ($key, $locale=null)
	getHasLoadableAdapters ()
	getId ()
	getLocaleMetadataFieldNames ()
	getLocalizedData ($key, $preferredLocale=null)
	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)
	unsetData ($key, $locale=null)
	upcastTo ($targetObject)

Data Fields
	$_issueFile
Data Fields inherited from DataObject
	$_data = array()
	$_extractionAdaptersLoaded = false
	$_hasLoadableAdapters = false
	$_injectionAdaptersLoaded = false
	$_metadataExtractionAdapters = array()
	$_metadataInjectionAdapters = array()

Detailed Description

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

See also

IssueGalleyDAO

Definition at line 24 of file IssueGalley.inc.php.

Member Function Documentation

getBestGalleyId()

IssueGalley::getBestGalleyId

(

)

Return the "best" issue galley ID – If a urlPath is set, use it; otherwise use the internal article Id.

Returns

string

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

References DataObject\getData(), and DataObject\getId().

getFile()

IssueGalley::getFile

(

)

Get the file corresponding to this galley.

Returns

IssueFile

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

References $_issueFile, DAORegistry\getDAO(), and getFileId().

getFileId()

IssueGalley::getFileId

(

)

Get file ID.

Returns

int

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

References DataObject\getData().

Referenced by getFile().

getGalleyLabel()

IssueGalley::getGalleyLabel

(

)

Get the localized value of the galley label.

Returns

$string

Definition at line 64 of file IssueGalley.inc.php.

References PKPLocale\getAllLocales(), getLabel(), AppLocale\getLocale(), and getLocale().

getLabel()

IssueGalley::getLabel

(

)

Get label/title.

Returns

string

Definition at line 77 of file IssueGalley.inc.php.

References DataObject\getData().

Referenced by getGalleyLabel().

getLocale()

IssueGalley::getLocale

(

)

Get locale.

Returns

string

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

References DataObject\getData().

Referenced by getGalleyLabel().

getSequence()

IssueGalley::getSequence

(

)

Get sequence order.

Returns

float

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

References DataObject\getData().

getStoredPubId()

IssueGalley::getStoredPubId

(

$pubIdType

)

Get stored public ID of the galley.

Parameters

$pubIdType

string 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

string

Definition at line 144 of file IssueGalley.inc.php.

References DataObject\getData().

getViews()

IssueGalley::getViews

(

)

Get views count.

Returns

int

Definition at line 55 of file IssueGalley.inc.php.

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

isPdfGalley()

IssueGalley::isPdfGalley

(

)

Check if galley is a PDF galley.

Returns

boolean

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

References PKPFile\getFileType().

setFileId()

IssueGalley::setFileId

(

$fileId

)

Set file ID.

Parameters

$fileId

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

References DataObject\setData().

setLabel()

IssueGalley::setLabel

(

$label

)

Set label/title.

Parameters

$label

string

Definition at line 85 of file IssueGalley.inc.php.

References DataObject\setData().

setLocale()

IssueGalley::setLocale

(

$locale

)

Set locale.

Parameters

$locale

string

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

References DataObject\setData().

setSequence()

IssueGalley::setSequence

(

$sequence

)

Set sequence order.

Parameters

$sequence

float

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

References DataObject\setData().

setStoredPubId()

IssueGalley::setStoredPubId	(		$pubIdType,
			$pubId
	)

Set stored public galley id.

Parameters

$pubIdType	string 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).
$pubId	string

Definition at line 155 of file IssueGalley.inc.php.

References DataObject\setData().

Field Documentation

$_issueFile

IssueFile IssueGalley::$_issueFile

Definition at line 29 of file IssueGalley.inc.php.

Referenced by getFile().

---

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

• IssueGalley.inc.php