PHP Class Article, ojs

User: Admin Date: 21.02.2015 Time: 13:26
Show file Open project: pkp/ojs Class Usage Examples

Public Methods

Method Description
__construct ( ) Constructor.
_getContextLicenseFieldValue ( $locale, $field ) : string | null Get the value of a license field from the containing context.
getBestArticleId ( ) : string Return the "best" article ID -- If a public article ID is set, use it; otherwise use the internal article Id.
getContextId ( ) : integer Get the context ID.
getCoverImage ( $locale ) : string get cover page server-side file name
getCoverImageAltText ( $locale ) : string get cover page alternate text
getCurrentRound ( ) : integer Get current review round.
getEndingPage ( ) : integer Get ending page of an article.
getFastTracked ( ) : boolean get expedited
getJournalId ( ) : integer Get ID of journal.
getLocalizedCoverImage ( ) : string Get the localized cover page server-side file name
getLocalizedCoverImageAltText ( ) : string Get the localized cover page alternate text
getLocalizedCoverImageUrl ( ) : string Get a full URL to the localized cover image
getSectionAbbrev ( ) : string Get section abbreviation.
getSectionId ( ) : integer Get ID of article's section.
getSectionTitle ( ) : string Get title of article's section.
getStartingPage ( ) : integer Get starting page of an article.
setContextId ( $contextId ) Set the context ID.
setCoverImage ( $coverImage, $locale ) set cover page server-side file name
setCoverImageAltText ( $coverImageAltText, $locale ) set cover page alternate text
setCurrentRound ( $currentRound ) Set current review round.
setFastTracked ( $fastTracked ) set fastTracked
setJournalId ( $journalId ) Set ID of journal.
setSectionAbbrev ( $sectionAbbrev ) Set section abbreviation.
setSectionId ( $sectionId ) Set ID of article's section.
setSectionTitle ( $sectionTitle ) Set title of article's section.

Method Details

__construct() public method

Constructor.
public __construct ( )

_getContextLicenseFieldValue() public method

Get the value of a license field from the containing context.
public _getContextLicenseFieldValue ( $locale, $field ) : string | null
$locale string Locale code
$field PERMISSIONS_FIELD_...
return string | null

getBestArticleId() public method

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

getContextId() public method

Get the context ID.
public getContextId ( ) : integer
return integer

getCoverImage() public method

get cover page server-side file name
public getCoverImage ( $locale ) : string
$locale string
return string

getCoverImageAltText() public method

get cover page alternate text
public getCoverImageAltText ( $locale ) : string
$locale string
return string

getCurrentRound() public method

Get current review round.
public getCurrentRound ( ) : integer
return integer

getEndingPage() public method

Get ending page of an article.
public getEndingPage ( ) : integer
return integer

getFastTracked() public method

get expedited
public getFastTracked ( ) : boolean
return boolean

getJournalId() public method

Get ID of journal.
public getJournalId ( ) : integer
return integer

getLocalizedCoverImage() public method

Get the localized cover page server-side file name
public getLocalizedCoverImage ( ) : string
return string

getLocalizedCoverImageAltText() public method

Get the localized cover page alternate text
public getLocalizedCoverImageAltText ( ) : string
return string

getLocalizedCoverImageUrl() public method

Get a full URL to the localized cover image
public getLocalizedCoverImageUrl ( ) : string
return string

getSectionAbbrev() public method

Get section abbreviation.
public getSectionAbbrev ( ) : string
return string

getSectionId() public method

Get ID of article's section.
public getSectionId ( ) : integer
return integer

getSectionTitle() public method

Get title of article's section.
public getSectionTitle ( ) : string
return string

getStartingPage() public method

Get starting page of an article.
public getStartingPage ( ) : integer
return integer

setContextId() public method

Set the context ID.
public setContextId ( $contextId )
$contextId int

setCoverImage() public method

set cover page server-side file name
public setCoverImage ( $coverImage, $locale )
$coverImage string
$locale string

setCoverImageAltText() public method

set cover page alternate text
public setCoverImageAltText ( $coverImageAltText, $locale )
$coverImageAltText string
$locale string

setCurrentRound() public method

Set current review round.
public setCurrentRound ( $currentRound )
$currentRound int

setFastTracked() public method

set fastTracked
public setFastTracked ( $fastTracked )
$fastTracked boolean

setJournalId() public method

Set ID of journal.
public setJournalId ( $journalId )
$journalId int

setSectionAbbrev() public method

Set section abbreviation.
public setSectionAbbrev ( $sectionAbbrev )
$sectionAbbrev string

setSectionId() public method

Set ID of article's section.
public setSectionId ( $sectionId )
$sectionId int

setSectionTitle() public method

Set title of article's section.
public setSectionTitle ( $sectionTitle )
$sectionTitle string