PHP Class ArticleGalley, ojs

Inheritance: extends ArticleFile
Mostra file Open project: pkp/ojs Class Usage Examples

Public Properties

Property Type Description
$_submissionFile SubmissionFile

Public Methods

Method Description
__construct ( ) Constructor.
getBestGalleyId ( ) : string Return the "best" article ID -- If a public article ID is set, use it; otherwise use the internal article Id.
getFile ( ) : SubmissionFile Get the submission file corresponding to this galley.
getFileId ( ) : integer Get file id
getFileType ( ) : string Get the file type corresponding to this galley.
getGalleyLabel ( ) : string Get the localized galley label.
getLabel ( ) : string Get label/title.
getLocale ( ) : string Get locale.
getLocalizedName ( ) : string Override the parent class to fetch the non-localized label.
getName ( $locale ) : array
getViews ( ) : integer Get views count.
isPdfGalley ( ) : boolean Determine whether the galley is a PDF.
setFileId ( $fileId ) Set file ID.
setLabel ( $label ) Set label/title.
setLocale ( $locale ) Set locale.

Method Details

__construct() public method

Constructor.
public __construct ( )

getBestGalleyId() public method

Return the "best" article ID -- If a public article ID is set, use it; otherwise use the internal article Id.
public getBestGalleyId ( ) : string
return string

getFile() public method

Get the submission file corresponding to this galley.
public getFile ( ) : SubmissionFile
return SubmissionFile

getFileId() public method

Get file id
public getFileId ( ) : integer
return integer

getFileType() public method

Get the file type corresponding to this galley.
public getFileType ( ) : string
return string MIME type

getGalleyLabel() public method

Get the localized galley label.
public getGalleyLabel ( ) : string
return string

getLabel() public method

Get label/title.
public getLabel ( ) : string
return string

getLocale() public method

Get locale.
public getLocale ( ) : string
return string

getLocalizedName() public method

Override the parent class to fetch the non-localized label.
See also: Representation::getLocalizedName()
public getLocalizedName ( ) : string
return string

getName() public method

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.
public getName ( $locale ) : array
$locale string unused, except to match the function prototype in Representation.
return array

getViews() public method

Get views count.
public getViews ( ) : integer
return integer

isPdfGalley() public method

Determine whether the galley is a PDF.
public isPdfGalley ( ) : boolean
return boolean

setFileId() public method

Set file ID.
public setFileId ( $fileId )
$fileId int

setLabel() public method

Set label/title.
public setLabel ( $label )
$label string

setLocale() public method

Set locale.
public setLocale ( $locale )
$locale string

Property Details

$_submissionFile public_oe property

public SubmissionFile $_submissionFile
return SubmissionFile