Open Journal Systems  3.3.0
ArticleGalley Class Reference
Inheritance diagram for ArticleGalley:
Representation DataObject

Public Member Functions

 getBestGalleyId ()
 
 getFile ()
 
 getFileId ()
 
 getFileType ()
 
 getGalleyLabel ()
 
 getLabel ()
 
 getLocale ()
 
 getLocalizedName ()
 
 getName ($locale)
 
 getViews ()
 
 isPdfGalley ()
 
 setFileId ($fileId)
 
 setLabel ($label)
 
 setLocale ($locale)
 
- Public Member Functions inherited from Representation
 __construct ()
 
 getContextId ()
 
 getDAO ()
 
 getIsApproved ()
 
 getRemoteURL ()
 
 getRepresentationFiles ($fileStage=null)
 
 getSequence ()
 
 getStoredPubId ($pubIdType)
 
 setIsApproved ($isApproved)
 
 setName ($name, $locale=null)
 
 setRemoteURL ($remoteURL)
 
 setSequence ($seq)
 
 setStoredPubId ($pubIdType, $pubId)
 
- Public Member Functions inherited from DataObject
 addSupportedMetadataAdapter ($metadataAdapter)
 
 extractMetadata ($metadataSchema)
 
 getAdditionalMetadataFieldNames ()
 
getAllData ()
 
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

 $_submissionFile
 
- 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 article.

See also
ArticleGalleyDAO

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

Member Function Documentation

◆ getBestGalleyId()

ArticleGalley::getBestGalleyId ( )

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

Returns
string

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

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

◆ getFile()

ArticleGalley::getFile ( )

Get the submission file corresponding to this galley.

Returns
SubmissionFile

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

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

Referenced by getFileType().

◆ getFileId()

ArticleGalley::getFileId ( )

Get file id

Returns
int

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

References DataObject\getData().

Referenced by getFile(), and getViews().

◆ getFileType()

ArticleGalley::getFileType ( )

Get the file type corresponding to this galley.

Returns
string MIME type

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

References getFile().

Referenced by isPdfGalley().

◆ getGalleyLabel()

ArticleGalley::getGalleyLabel ( )

Get the localized galley label.

Returns
string

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

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

◆ getLabel()

ArticleGalley::getLabel ( )

Get label/title.

Returns
string

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

References DataObject\getData().

Referenced by getGalleyLabel(), getLocalizedName(), and getName().

◆ getLocale()

ArticleGalley::getLocale ( )

Get locale.

Returns
string

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

References DataObject\getData().

Referenced by getGalleyLabel(), and getName().

◆ getLocalizedName()

ArticleGalley::getLocalizedName ( )

Override the parent class to fetch the non-localized label.

See also
Representation::getLocalizedName()
Returns
string

Reimplemented from Representation.

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

References getLabel().

◆ getName()

ArticleGalley::getName (   $locale)
See also
Representation::getName()

This override exists to provide a functional getName() in order to make native XML export work correctly. It is only used in that single instance.

Parameters
$localestring unused, except to match the function prototype in Representation.
Returns
array

Reimplemented from Representation.

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

References getLabel(), and getLocale().

◆ getViews()

ArticleGalley::getViews ( )

Get views count.

Returns
int

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

References $application, PKPApplication\get(), and getFileId().

◆ isPdfGalley()

ArticleGalley::isPdfGalley ( )

Determine whether the galley is a PDF.

Returns
boolean

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

References getFileType().

◆ setFileId()

ArticleGalley::setFileId (   $fileId)

Set file ID.

Parameters
$fileIdint

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

References DataObject\setData().

◆ setLabel()

ArticleGalley::setLabel (   $label)

Set label/title.

Parameters
$labelstring

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

References DataObject\setData().

◆ setLocale()

ArticleGalley::setLocale (   $locale)

Set locale.

Parameters
$localestring

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

References DataObject\setData().

Field Documentation

◆ $_submissionFile

SubmissionFile ArticleGalley::$_submissionFile

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

Referenced by getFile().


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