PHP Class Section, ojs

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

Public Methods

Method Description
__construct ( ) Constructor.
getAbbrev ( $locale ) : string Get section title abbreviation.
getAbstractWordCount ( ) : integer Get abstract word count limit.
getAbstractsNotRequired ( ) : boolean Get boolean indicating whether abstracts are required
getHideAbout ( ) : boolean Return boolean indicating if title should be hidden in About.
getHideAuthor ( ) : boolean Return boolean indicating if author should be hidden in issue ToC.
getHideTitle ( ) : boolean Return boolean indicating if title should be hidden in issue ToC.
getIdentifyType ( $locale ) : string Get string identifying type of items in this section.
getJournalId ( ) : integer Get ID of journal.
getLocalizedAbbrev ( ) : string Get localized abbreviation of journal section.
getLocalizedIdentifyType ( ) : string Get localized string identifying type of items in this section.
getLocalizedPolicy ( ) : string Get localized section policy.
getMetaIndexed ( ) : boolean Get open archive setting of section.
getMetaReviewed ( ) : boolean Get peer-reviewed setting of section.
getPolicy ( $locale ) : string Get policy.
setAbbrev ( $abbrev, $locale ) Set section title abbreviation.
setAbstractWordCount ( $wordCount ) Set abstract word count limit.
setAbstractsNotRequired ( $abstractsNotRequired ) Set boolean indicating whether abstracts are required
setHideAbout ( $hideAbout ) Set if title should be hidden in About.
setHideAuthor ( $hideAuthor ) Set if author should be hidden in issue ToC.
setHideTitle ( $hideTitle ) Set if title should be hidden in issue ToC.
setIdentifyType ( $identifyType, $locale ) Set string identifying type of items in this section.
setJournalId ( $journalId ) Set ID of journal.
setMetaIndexed ( $metaIndexed ) Set open archive setting of section.
setMetaReviewed ( $metaReviewed ) Set peer-reviewed setting of section.
setPolicy ( $policy, $locale ) Set policy.

Method Details

__construct() public method

Constructor.
public __construct ( )

getAbbrev() public method

Get section title abbreviation.
public getAbbrev ( $locale ) : string
$locale string
return string

getAbstractWordCount() public method

Get abstract word count limit.
public getAbstractWordCount ( ) : integer
return integer

getAbstractsNotRequired() public method

Get boolean indicating whether abstracts are required
public getAbstractsNotRequired ( ) : boolean
return boolean

getHideAbout() public method

Return boolean indicating if title should be hidden in About.
public getHideAbout ( ) : boolean
return boolean

getHideAuthor() public method

Return boolean indicating if author should be hidden in issue ToC.
public getHideAuthor ( ) : boolean
return boolean

getHideTitle() public method

Return boolean indicating if title should be hidden in issue ToC.
public getHideTitle ( ) : boolean
return boolean

getIdentifyType() public method

Get string identifying type of items in this section.
public getIdentifyType ( $locale ) : string
$locale string
return string

getJournalId() public method

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

getLocalizedAbbrev() public method

Get localized abbreviation of journal section.
public getLocalizedAbbrev ( ) : string
return string

getLocalizedIdentifyType() public method

Get localized string identifying type of items in this section.
public getLocalizedIdentifyType ( ) : string
return string

getLocalizedPolicy() public method

Get localized section policy.
public getLocalizedPolicy ( ) : string
return string

getMetaIndexed() public method

Get open archive setting of section.
public getMetaIndexed ( ) : boolean
return boolean

getMetaReviewed() public method

Get peer-reviewed setting of section.
public getMetaReviewed ( ) : boolean
return boolean

getPolicy() public method

Get policy.
public getPolicy ( $locale ) : string
$locale string
return string

setAbbrev() public method

Set section title abbreviation.
public setAbbrev ( $abbrev, $locale )
$abbrev string
$locale string

setAbstractWordCount() public method

Set abstract word count limit.
public setAbstractWordCount ( $wordCount )
$wordCount int

setAbstractsNotRequired() public method

Set boolean indicating whether abstracts are required
public setAbstractsNotRequired ( $abstractsNotRequired )
$abstractsNotRequired boolean

setHideAbout() public method

Set if title should be hidden in About.
public setHideAbout ( $hideAbout )
$hideAbout boolean

setHideAuthor() public method

Set if author should be hidden in issue ToC.
public setHideAuthor ( $hideAuthor )
$hideAuthor boolean

setHideTitle() public method

Set if title should be hidden in issue ToC.
public setHideTitle ( $hideTitle )
$hideTitle boolean

setIdentifyType() public method

Set string identifying type of items in this section.
public setIdentifyType ( $identifyType, $locale )
$identifyType string
$locale string

setJournalId() public method

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

setMetaIndexed() public method

Set open archive setting of section.
public setMetaIndexed ( $metaIndexed )
$metaIndexed boolean

setMetaReviewed() public method

Set peer-reviewed setting of section.
public setMetaReviewed ( $metaReviewed )
$metaReviewed boolean

setPolicy() public method

Set policy.
public setPolicy ( $policy, $locale )
$policy string
$locale string