Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
IssueGalley Class Reference
Inheritance diagram for IssueGalley:
IssueFile PKPFile DataObject

Public Member Functions

 getBestGalleyId (&$journal)
 
 getFileId ()
 
 getGalleyLabel ()
 
 getLabel ()
 
 getLocale ()
 
 getSequence ()
 
 getStoredPubId ($pubIdType)
 
 getViews ()
 
 isPdfGalley ()
 
 IssueGalley ()
 
 setFileId ($fileId)
 
 setLabel ($label)
 
 setLocale ($locale)
 
 setSequence ($sequence)
 
 setStoredPubId ($pubIdType, $pubId)
 
- Public Member Functions inherited from IssueFile
 getContentType ()
 
 getDateModified ()
 
 getIssueId ()
 
 IssueFile ()
 
 setContentType ($contentType)
 
 setDateModified ($dateModified)
 
 setIssueId ($issueId)
 
- Public Member Functions inherited from PKPFile
 getDateUploaded ()
 
 getFileId ()
 
 getFileName ()
 
 getFilePath ()
 
 getFileSize ()
 
 getFileType ()
 
 getNiceFileSize ()
 
 getOriginalFileName ()
 
 PKPFile ()
 
 setDateUploaded ($dateUploaded)
 
 setFileId ($fileId)
 
 setFileName ($fileName)
 
 setFileSize ($fileSize)
 
 setFileType ($fileType)
 
 setOriginalFileName ($originalFileName)
 
- 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

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

See Also
IssueGalleyDAO

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

Member Function Documentation

IssueGalley::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
$journalObject the journal this galley is in
Returns
string

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

References DataObject\getId().

IssueGalley::getFileId ( )

Get file ID.

Returns
int

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

References DataObject\getData().

IssueGalley::getGalleyLabel ( )

Get the localized value of the galley label.

Returns
$string

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

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

IssueGalley::getLabel ( )

Get label/title.

Returns
string

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

References DataObject\getData().

Referenced by getGalleyLabel().

IssueGalley::getLocale ( )

Get locale.

Returns
string

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

References DataObject\getData().

Referenced by getGalleyLabel().

IssueGalley::getSequence ( )

Get sequence order.

Returns
float

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

References DataObject\getData().

IssueGalley::getStoredPubId (   $pubIdType)

Get stored public ID of the galley.

Parameters
$pubIdTypestring 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 159 of file IssueGalley.inc.php.

References DataObject\getData().

IssueGalley::getViews ( )

Get views count.

Returns
int

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

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

IssueGalley::isPdfGalley ( )

Check if galley is a PDF galley.

Returns
boolean

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

References PKPFile\getFileType().

IssueGalley::IssueGalley ( )

Constructor.

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

IssueGalley::setFileId (   $fileId)

Set file ID.

Parameters
$fileId

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

References DataObject\setData().

IssueGalley::setLabel (   $label)

Set label/title.

Parameters
$labelstring

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

References DataObject\setData().

IssueGalley::setLocale (   $locale)

Set locale.

Parameters
$localestring

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

References DataObject\setData().

IssueGalley::setSequence (   $sequence)

Set sequence order.

Parameters
$sequencefloat

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

References DataObject\setData().

IssueGalley::setStoredPubId (   $pubIdType,
  $pubId 
)

Set stored public galley id.

Parameters
$pubIdTypestring 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).
$pubIdstring

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

References DataObject\setData().


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