PHP Class Issue, ojs

Inheritance: extends Eloquent
Show file Open project: pkp/ojs Class Usage Examples

Public Methods

Method Description
getAccessStatus ( ) : integer get access status (ISSUE_ACCESS_.
getAuthorString ( $lastOnly = false, $separator = ', ' ) : string Return string of author names, separated by the specified token
getBestIssueId ( ) : string Return the "best" issue ID -- If a public issue ID is set, use it; otherwise use the internal issue Id.
getCoverImage ( $locale ) : string Get issue cover image file name
getCoverImageAltText ( $locale ) : string Get issue cover image alternate text
getCurrent ( ) : integer get current
getDAO ( )
getDateNotified ( ) : date get date the users were last notified
getDatePublished ( ) : date get date published
getDescription ( $locale ) : string get description
getIssueIdentification ( $force = [] ) : string Return the string of the issue identification based label format
getIssueSeries ( ) : string Return the string of the issue series identification eg: Vol 1 No 1 (2000)
getJournalId ( ) : integer get journal id
getLastModified ( ) : date get date the issue was last modified
getLocalizedCoverImage ( ) : string Get the localized issue cover image file name
getLocalizedCoverImageAltText ( ) : string Get the localized issue cover image alternate text
getLocalizedCoverImageUrl ( ) : string Get a full URL to the localized cover image
getLocalizedDescription ( ) : string Get the localized description
getLocalizedTitle ( ) : string Get the localized title
getNumArticles ( ) : integer Get number of articles in this issue.
getNumber ( ) : string get number
getOpenAccessDate ( ) : date get open access date
getPublished ( ) : integer get published
getShowNumber ( ) : integer get show issue number
getShowTitle ( ) : integer get show issue title
getShowVolume ( ) : integer get show issue volume
getShowYear ( ) : integer get show issue year
getStoredPubId ( $pubIdType ) : string Get stored public ID of the issue.
getTitle ( $locale ) : string get title
getVolume ( ) : integer get volume
getYear ( ) : integer get year
hasDescription ( ) : boolean Check whether a description exists for this issue
setAccessStatus ( $accessStatus ) set access status (ISSUE_ACCESS_.
setCoverImage ( $coverImage, $locale ) Set issue cover image file name
setCoverImageAltText ( $coverImageAltText, $locale ) Set issue cover image alternate text
setCurrent ( $current ) set current
setDateNotified ( $dateNotified ) set date the users were last notified
setDatePublished ( $datePublished ) set date published
setDescription ( $description, $locale ) set description
setJournalId ( $journalId ) set journal id
setLastModified ( $lastModified ) set date the issue was last modified
setNumber ( $number ) set number
setOpenAccessDate ( $openAccessDate ) set open access date
setPublished ( $published ) set published
setShowNumber ( $showNumber ) set show issue number
setShowTitle ( $showTitle ) set show issue title
setShowVolume ( $showVolume ) set show issue volume
setShowYear ( $showYear ) set show issue year
setStoredPubId ( $pubIdType, $pubId ) Set stored public issue id.
setTitle ( $title, $locale ) set title
setVolume ( $volume ) set volume
setYear ( $year ) set year
stampModified ( ) Stamp the date of the last modification to the current time.

Method Details

getAccessStatus() public method

..)
public getAccessStatus ( ) : integer
return integer

getAuthorString() public method

Return string of author names, separated by the specified token
public getAuthorString ( $lastOnly = false, $separator = ', ' ) : string
$lastOnly boolean return list of lastnames only (default false)
$separator string separator for names (default comma+space)
return string

getBestIssueId() public method

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

getCoverImage() public method

Get issue cover image file name
public getCoverImage ( $locale ) : string
$locale string
return string

getCoverImageAltText() public method

Get issue cover image alternate text
public getCoverImageAltText ( $locale ) : string
$locale string
return string

getCurrent() public method

get current
public getCurrent ( ) : integer
return integer

getDAO() public method

public getDAO ( )

getDateNotified() public method

get date the users were last notified
public getDateNotified ( ) : date
return date

getDatePublished() public method

get date published
public getDatePublished ( ) : date
return date

getDescription() public method

get description
public getDescription ( $locale ) : string
$locale string
return string

getIssueIdentification() public method

Return the string of the issue identification based label format
public getIssueIdentification ( $force = [] ) : string
$force array force show/hide of data components
return string

getIssueSeries() public method

Return the string of the issue series identification eg: Vol 1 No 1 (2000)
public getIssueSeries ( ) : string
return string

getJournalId() public method

get journal id
public getJournalId ( ) : integer
return integer

getLastModified() public method

get date the issue was last modified
public getLastModified ( ) : date
return date

getLocalizedCoverImage() public method

Get the localized issue cover image file name
public getLocalizedCoverImage ( ) : string
return string

getLocalizedCoverImageAltText() public method

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

getLocalizedCoverImageUrl() public method

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

getLocalizedDescription() public method

Get the localized description
public getLocalizedDescription ( ) : string
return string

getLocalizedTitle() public method

Get the localized title
public getLocalizedTitle ( ) : string
return string

getNumArticles() public method

Get number of articles in this issue.
public getNumArticles ( ) : integer
return integer

getNumber() public method

get number
public getNumber ( ) : string
return string

getOpenAccessDate() public method

get open access date
public getOpenAccessDate ( ) : date
return date

getPublished() public method

get published
public getPublished ( ) : integer
return integer

getShowNumber() public method

get show issue number
public getShowNumber ( ) : integer
return integer

getShowTitle() public method

get show issue title
public getShowTitle ( ) : integer
return integer

getShowVolume() public method

get show issue volume
public getShowVolume ( ) : integer
return integer

getShowYear() public method

get show issue year
public getShowYear ( ) : integer
return integer

getStoredPubId() public method

Get stored public ID of the issue.
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

getTitle() public method

get title
public getTitle ( $locale ) : string
$locale string
return string

getVolume() public method

get volume
public getVolume ( ) : integer
return integer

getYear() public method

get year
public getYear ( ) : integer
return integer

hasDescription() public method

Check whether a description exists for this issue
public hasDescription ( ) : boolean
return boolean

setAccessStatus() public method

..)
public setAccessStatus ( $accessStatus )
$accessStatus int

setCoverImage() public method

Set issue cover image file name
public setCoverImage ( $coverImage, $locale )
$coverImage string
$locale string

setCoverImageAltText() public method

Set issue cover image alternate text
public setCoverImageAltText ( $coverImageAltText, $locale )
$coverImageAltText string
$locale string

setCurrent() public method

set current
public setCurrent ( $current )
$current int

setDateNotified() public method

set date the users were last notified
public setDateNotified ( $dateNotified )
$dateNotified date

setDatePublished() public method

set date published
public setDatePublished ( $datePublished )
$datePublished date

setDescription() public method

set description
public setDescription ( $description, $locale )
$description string
$locale string

setJournalId() public method

set journal id
public setJournalId ( $journalId )
$journalId int

setLastModified() public method

set date the issue was last modified
public setLastModified ( $lastModified )
$lastModified date

setNumber() public method

set number
public setNumber ( $number )
$number string

setOpenAccessDate() public method

set open access date
public setOpenAccessDate ( $openAccessDate )
$openAccessDate date

setPublished() public method

set published
public setPublished ( $published )
$published int

setShowNumber() public method

set show issue number
public setShowNumber ( $showNumber )
$showNumber int

setShowTitle() public method

set show issue title
public setShowTitle ( $showTitle )
$showTitle int

setShowVolume() public method

set show issue volume
public setShowVolume ( $showVolume )
$showVolume int

setShowYear() public method

set show issue year
public setShowYear ( $showYear )
$showYear int

setStoredPubId() public method

Set stored public issue 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

setTitle() public method

set title
public setTitle ( $title, $locale )
$title string
$locale string

setVolume() public method

set volume
public setVolume ( $volume )
$volume int

setYear() public method

set year
public setYear ( $year )
$year int

stampModified() public method

Stamp the date of the last modification to the current time.
public stampModified ( )