Open Journal Systems  3.3.0
Section Class Reference
Inheritance diagram for Section:
PKPSection DataObject

Public Member Functions

 getAbbrev ($locale)
 
 getAbstractsNotRequired ()
 
 getAbstractWordCount ()
 
 getHideAuthor ()
 
 getHideTitle ()
 
 getIdentifyType ($locale)
 
 getIsInactive ()
 
 getJournalId ()
 
 getLocalizedAbbrev ()
 
 getLocalizedIdentifyType ()
 
 getMetaIndexed ()
 
 getMetaReviewed ()
 
 setAbbrev ($abbrev, $locale)
 
 setAbstractsNotRequired ($abstractsNotRequired)
 
 setAbstractWordCount ($wordCount)
 
 setHideAuthor ($hideAuthor)
 
 setHideTitle ($hideTitle)
 
 setIdentifyType ($identifyType, $locale)
 
 setIsInactive ($isInactive)
 
 setJournalId ($journalId)
 
 setMetaIndexed ($metaIndexed)
 
 setMetaReviewed ($metaReviewed)
 
- Public Member Functions inherited from PKPSection
 getContextId ()
 
 getEditorRestricted ()
 
 getLocalizedPolicy ()
 
 getLocalizedTitle ()
 
 getPolicy ($locale)
 
 getReviewFormId ()
 
 getSequence ()
 
 getTitle ($locale)
 
 getViews ()
 
 setContextId ($contextId)
 
 setEditorRestricted ($editorRestricted)
 
 setPolicy ($policy, $locale)
 
 setReviewFormId ($reviewFormId)
 
 setSequence ($sequence)
 
 setTitle ($title, $locale)
 
- Public Member Functions inherited from DataObject
 __construct ()
 
 addSupportedMetadataAdapter ($metadataAdapter)
 
 extractMetadata ($metadataSchema)
 
 getAdditionalMetadataFieldNames ()
 
getAllData ()
 
 getDAO ()
 
getData ($key, $locale=null)
 
 getHasLoadableAdapters ()
 
 getId ()
 
 getLocaleMetadataFieldNames ()
 
 getLocalizedData ($key, $preferredLocale=null)
 
 getMetadataFieldNames ($translated=true)
 
 getSetMetadataFieldNames ($translated=true)
 
 getSupportedExtractionAdapters ()
 
 getSupportedInjectionAdapters ()
 
 getSupportedMetadataSchemas ()
 
 hasData ($key, $locale=null)
 
 injectMetadata ($metadataDescription)
 
 removeSupportedMetadataAdapter ($metadataSchemaName)
 
 setAllData (&$data)
 
 setData ($key, $value, $locale=null)
 
 setHasLoadableAdapters ($hasLoadableAdapters)
 
 setId ($id)
 
 unsetData ($key, $locale=null)
 
 upcastTo ($targetObject)
 

Additional Inherited Members

- Data Fields inherited from DataObject
 $_data = array()
 
 $_extractionAdaptersLoaded = false
 
 $_hasLoadableAdapters = false
 
 $_injectionAdaptersLoaded = false
 
 $_metadataExtractionAdapters = array()
 
 $_metadataInjectionAdapters = array()
 

Detailed Description

Describes basic section properties.

See also
SectionDAO

Definition at line 19 of file Section.inc.php.

Member Function Documentation

◆ getAbbrev()

Section::getAbbrev (   $locale)

Get section title abbreviation.

Parameters
$localestring
Returns
string

Definition at line 55 of file Section.inc.php.

References DataObject\getData().

◆ getAbstractsNotRequired()

Section::getAbstractsNotRequired ( )

Get boolean indicating whether abstracts are required

Returns
boolean

Definition at line 120 of file Section.inc.php.

References DataObject\getData().

◆ getAbstractWordCount()

Section::getAbstractWordCount ( )

Get abstract word count limit.

Returns
int

Definition at line 72 of file Section.inc.php.

References DataObject\getData().

◆ getHideAuthor()

Section::getHideAuthor ( )

Return boolean indicating if author should be hidden in issue ToC.

Returns
boolean

Definition at line 178 of file Section.inc.php.

References DataObject\getData().

◆ getHideTitle()

Section::getHideTitle ( )

Return boolean indicating if title should be hidden in issue ToC.

Returns
boolean

Definition at line 162 of file Section.inc.php.

References DataObject\getData().

◆ getIdentifyType()

Section::getIdentifyType (   $locale)

Get string identifying type of items in this section.

Parameters
$localestring
Returns
string

Definition at line 145 of file Section.inc.php.

References DataObject\getData().

◆ getIsInactive()

Section::getIsInactive ( )

Return boolean indicating if section should be inactivated.

Returns
int

Definition at line 194 of file Section.inc.php.

References DataObject\getData().

◆ getJournalId()

Section::getJournalId ( )

Get ID of journal.

Returns
int

Definition at line 38 of file Section.inc.php.

References PKPSection\getContextId().

◆ getLocalizedAbbrev()

Section::getLocalizedAbbrev ( )

Get localized abbreviation of journal section.

Returns
string

Definition at line 25 of file Section.inc.php.

References DataObject\getLocalizedData().

◆ getLocalizedIdentifyType()

Section::getLocalizedIdentifyType ( )

Get localized string identifying type of items in this section.

Returns
string

Definition at line 136 of file Section.inc.php.

References DataObject\getLocalizedData().

◆ getMetaIndexed()

Section::getMetaIndexed ( )

Get "will/will not be indexed" setting of section.

Returns
boolean

Definition at line 88 of file Section.inc.php.

References DataObject\getData().

◆ getMetaReviewed()

Section::getMetaReviewed ( )

Get peer-reviewed setting of section.

Returns
boolean

Definition at line 104 of file Section.inc.php.

References DataObject\getData().

◆ setAbbrev()

Section::setAbbrev (   $abbrev,
  $locale 
)

Set section title abbreviation.

Parameters
$abbrevstring
$localestring

Definition at line 64 of file Section.inc.php.

References DataObject\setData().

◆ setAbstractsNotRequired()

Section::setAbstractsNotRequired (   $abstractsNotRequired)

Set boolean indicating whether abstracts are required

Parameters
$abstractsNotRequiredboolean

Definition at line 128 of file Section.inc.php.

References DataObject\setData().

◆ setAbstractWordCount()

Section::setAbstractWordCount (   $wordCount)

Set abstract word count limit.

Parameters
$wordCountint

Definition at line 80 of file Section.inc.php.

References DataObject\setData().

◆ setHideAuthor()

Section::setHideAuthor (   $hideAuthor)

Set if author should be hidden in issue ToC.

Parameters
$hideAuthorboolean

Definition at line 186 of file Section.inc.php.

References DataObject\setData().

◆ setHideTitle()

Section::setHideTitle (   $hideTitle)

Set if title should be hidden in issue ToC.

Parameters
$hideTitleboolean

Definition at line 170 of file Section.inc.php.

References DataObject\setData().

◆ setIdentifyType()

Section::setIdentifyType (   $identifyType,
  $locale 
)

Set string identifying type of items in this section.

Parameters
$identifyTypestring
$localestring

Definition at line 154 of file Section.inc.php.

References DataObject\setData().

◆ setIsInactive()

Section::setIsInactive (   $isInactive)

Set if section should be inactivated.

Parameters
$isInactiveint

Definition at line 202 of file Section.inc.php.

References DataObject\setData().

◆ setJournalId()

Section::setJournalId (   $journalId)

Set ID of journal.

Parameters
$journalIdint

Definition at line 46 of file Section.inc.php.

References PKPSection\setContextId().

◆ setMetaIndexed()

Section::setMetaIndexed (   $metaIndexed)

Set "will/will not be indexed" setting of section.

Parameters
$metaIndexedboolean

Definition at line 96 of file Section.inc.php.

References DataObject\setData().

◆ setMetaReviewed()

Section::setMetaReviewed (   $metaReviewed)

Set peer-reviewed setting of section.

Parameters
$metaReviewedboolean

Definition at line 112 of file Section.inc.php.

References DataObject\setData().


The documentation for this class was generated from the following file: