PHP Class IssueGalley, ojs

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

Public Properties

Property Type Description
$_issueFile IssueFile

Public Methods

Method Description
__construct ( ) Constructor.
getBestGalleyId ( ) : string Return the "best" issue galley ID -- If a public isue galley ID is set, use it; otherwise use the internal article Id.
getFile ( ) : IssueFile Get the file corresponding to this galley.
getFileId ( ) : integer Get file ID.
getGalleyLabel ( ) Get the localized value of the galley label.
getLabel ( ) : string Get label/title.
getLocale ( ) : string Get locale.
getSequence ( ) : float Get sequence order.
getStoredPubId ( $pubIdType ) : string Get stored public ID of the galley.
getViews ( ) : integer Get views count.
isPdfGalley ( ) : boolean Check if galley is a PDF galley.
setFileId ( $fileId ) Set file ID.
setLabel ( $label ) Set label/title.
setLocale ( $locale ) Set locale.
setSequence ( $sequence ) Set sequence order.
setStoredPubId ( $pubIdType, $pubId ) Set stored public galley id.

Method Details

__construct() public method

Constructor.
public __construct ( )

getBestGalleyId() public method

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

getFile() public method

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

getFileId() public method

Get file ID.
public getFileId ( ) : integer
return integer

getGalleyLabel() public method

Get the localized value of the galley label.
public getGalleyLabel ( )

getLabel() public method

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

getLocale() public method

Get locale.
public getLocale ( ) : string
return string

getSequence() public method

Get sequence order.
public getSequence ( ) : float
return float

getStoredPubId() public method

Get stored public ID of the galley.
public getStoredPubId ( $pubIdType ) : string
$pubIdType string One of the NLM pub-id-type values or 'other::something' if not part of the official NLM list (see ).
return string

getViews() public method

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

isPdfGalley() public method

Check if galley is a PDF galley.
public isPdfGalley ( ) : boolean
return boolean

setFileId() public method

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

setLabel() public method

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

setLocale() public method

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

setSequence() public method

Set sequence order.
public setSequence ( $sequence )
$sequence float

setStoredPubId() public method

Set stored public galley id.
public setStoredPubId ( $pubIdType, $pubId )
$pubIdType string One of the NLM pub-id-type values or 'other::something' if not part of the official NLM list (see ).
$pubId string

Property Details

$_issueFile public_oe property

public IssueFile $_issueFile
return IssueFile