Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
ArticleGalley Class Reference
Inheritance diagram for ArticleGalley:
ArticleFile SubmissionFile PKPFile DataObject ArticleHTMLGalley ArticleXMLGalley

Public Member Functions

 ArticleGalley ()
 
 getBestGalleyId (&$journal)
 
 getGalleyId ()
 
 getGalleyLabel ()
 
 getLabel ()
 
 getLocale ()
 
 getRemoteURL ()
 
 getSequence ()
 
 getViews ()
 
 isDependentFile ($fileId)
 
 isHTMLGalley ()
 
 isPdfGalley ()
 
 setGalleyId ($galleyId)
 
 setLabel ($label)
 
 setLocale ($locale)
 
 setRemoteURL ($remoteURL)
 
 setSequence ($sequence)
 
- Public Member Functions inherited from ArticleFile
 ArticleFile ()
 
 getArticleId ()
 
 getFilePath ()
 
 getStoredPubId ($pubIdType)
 
 isInlineable ()
 
 setArticleId ($articleId)
 
 setStoredPubId ($pubIdType, $pubId)
 
- Public Member Functions inherited from SubmissionFile
 getAssocId ()
 
 getDateModified ()
 
 getFileId ()
 
 getFileIdAndRevision ()
 
 getFileStage ()
 
 getRevision ()
 
 getRound ()
 
 getSourceFileId ()
 
 getSourceRevision ()
 
 getSubmissionId ()
 
 getType ()
 
 getViewable ()
 
 isInlineable ()
 
 setAssocId ($assocId)
 
 setDateModified ($dateModified)
 
 setFileId ($fileId)
 
 setFileStage ($fileStage)
 
 setRevision ($revision)
 
 setRound ($round)
 
 setSourceFileId ($sourceFileId)
 
 setSourceRevision ($sourceRevision)
 
 setSubmissionId ($submissionId)
 
 setType ($type)
 
 setViewable ($viewable)
 
 SubmissionFile ()
 
- 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 article.

See Also
ArticleGalleyDAO

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

Member Function Documentation

ArticleGalley::ArticleGalley ( )

Constructor.

Definition at line 24 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
$journalObject the journal this galley is in
Returns
string

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

References DataObject\getId().

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

ArticleGalley::getGalleyId ( )

Get ID of galley.

Returns
int

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

References DataObject\getId(), and Config\getVar().

ArticleGalley::getGalleyLabel ( )

Get the localized value of the galley label.

Returns
$string

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

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

ArticleGalley::getLabel ( )

Get label/title.

Returns
string

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

References DataObject\getData().

Referenced by getGalleyLabel().

ArticleGalley::getLocale ( )

Get locale.

Returns
string

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

References DataObject\getData().

Referenced by getGalleyLabel().

ArticleGalley::getRemoteURL ( )

Get remote URL of the galley.

Returns
string

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

References DataObject\getData().

ArticleGalley::getSequence ( )

Get sequence order of supplementary file.

Returns
float

Definition at line 140 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 PKPApplication\getApplication(), and DataObject\getId().

ArticleGalley::isDependentFile (   $fileId)

Check if the specified file is a dependent file.

Parameters
$fileIdint
Returns
boolean

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

ArticleGalley::isHTMLGalley ( )

Check if galley is an HTML galley.

Returns
boolean

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

ArticleGalley::isPdfGalley ( )

Check if galley is a PDF galley.

Returns
boolean

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

References PKPFile\getFileType().

Referenced by ArticleXMLGalley\_xsltCacheMiss().

ArticleGalley::setGalleyId (   $galleyId)

Set ID of galley.

Parameters
$galleyIdint

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

References Config\getVar(), and DataObject\setId().

ArticleGalley::setLabel (   $label)

Set label/title.

Parameters
$labelstring

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

References DataObject\setData().

ArticleGalley::setLocale (   $locale)

Set locale.

Parameters
$localestring

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

References DataObject\setData().

ArticleGalley::setRemoteURL (   $remoteURL)

Set remote URL of the galley.

Parameters
$remoteURLstring

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

References DataObject\setData().

ArticleGalley::setSequence (   $sequence)

Set sequence order of supplementary file.

Parameters
$sequencefloat

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

References DataObject\setData().


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