Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
Section Class Reference
Inheritance diagram for Section:
DataObject

Public Member Functions

 getAbbrev ($locale)
 
 getAbstractsNotRequired ()
 
 getAbstractWordCount ()
 
 getDisableComments ()
 
 getEditorRestricted ()
 
 getHideAbout ()
 
 getHideAuthor ()
 
 getHideTitle ()
 
 getIdentifyType ($locale)
 
 getJournalId ()
 
 getLocalizedAbbrev ()
 
 getLocalizedIdentifyType ()
 
 getLocalizedPolicy ()
 
 getLocalizedTitle ()
 
 getMetaIndexed ()
 
 getMetaReviewed ()
 
 getPolicy ($locale)
 
 getReviewFormId ()
 
 getSectionId ()
 
 getSequence ()
 
 getTitle ($locale)
 
 Section ()
 
 setAbbrev ($abbrev, $locale)
 
 setAbstractsNotRequired ($abstractsNotRequired)
 
 setAbstractWordCount ($wordCount)
 
 setDisableComments ($disableComments)
 
 setEditorRestricted ($editorRestricted)
 
 setHideAbout ($hideAbout)
 
 setHideAuthor ($hideAuthor)
 
 setHideTitle ($hideTitle)
 
 setIdentifyType ($identifyType, $locale)
 
 setJournalId ($journalId)
 
 setMetaIndexed ($metaIndexed)
 
 setMetaReviewed ($metaReviewed)
 
 setPolicy ($policy, $locale)
 
 setReviewFormId ($reviewFormId)
 
 setSectionId ($sectionId)
 
 setSequence ($sequence)
 
 setTitle ($title, $locale)
 
- Public Member Functions inherited from DataObject
 addSupportedMetadataAdapter (&$metadataAdapter)
 
 DataObject ($callHooks=true)
 
extractMetadata (&$metadataSchema)
 
 getAdditionalMetadataFieldNames ()
 
getAllData ()
 
getData ($key, $locale=null)
 
 getHasLoadableAdapters ()
 
 getId ()
 
 getLocaleMetadataFieldNames ()
 
getLocalizedData ($key)
 
 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)
 
upcastTo (&$targetObject)
 

Additional Inherited Members

- Public Attributes inherited from DataObject
 $_data = array()
 

Detailed Description

Describes basic section properties.

See Also
SectionDAO

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

Member Function Documentation

Section::getAbbrev (   $locale)

Get section title abbreviation.

Parameters
$localestring
Returns
string

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

References DataObject\getData().

Section::getAbstractsNotRequired ( )

Get boolean indicating whether abstracts are required

Returns
boolean

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

References DataObject\getData().

Section::getAbstractWordCount ( )

Get abstract word count limit.

Returns
int

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

References DataObject\getData().

Section::getDisableComments ( )

Return boolean indicating if RT comments should be disabled.

Returns
boolean

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

References DataObject\getData().

Section::getEditorRestricted ( )

Return boolean indicating whether or not submissions are restricted to [section]Editors.

Returns
boolean

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

References DataObject\getData().

Section::getHideAbout ( )

Return boolean indicating if title should be hidden in About.

Returns
boolean

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

References DataObject\getData().

Section::getHideAuthor ( )

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

Returns
boolean

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

References DataObject\getData().

Section::getHideTitle ( )

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

Returns
boolean

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

References DataObject\getData().

Section::getIdentifyType (   $locale)

Get string identifying type of items in this section.

Parameters
$localestring
Returns
string

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

References DataObject\getData().

Section::getJournalId ( )

Get ID of journal.

Returns
int

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

References DataObject\getData().

Section::getLocalizedAbbrev ( )

Get localized abbreviation of journal section.

Returns
string

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

References DataObject\getLocalizedData().

Section::getLocalizedIdentifyType ( )

Get localized string identifying type of items in this section.

Returns
string

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

References DataObject\getLocalizedData().

Section::getLocalizedPolicy ( )

Get localized section policy.

Returns
string

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

References DataObject\getLocalizedData().

Section::getLocalizedTitle ( )

Get localized title of journal section.

Returns
string

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

References DataObject\getLocalizedData().

Section::getMetaIndexed ( )

Get open archive setting of section.

Returns
boolean

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

References DataObject\getData().

Section::getMetaReviewed ( )

Get peer-reviewed setting of section.

Returns
boolean

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

References DataObject\getData().

Section::getPolicy (   $locale)

Get policy.

Parameters
$localestring
Returns
string

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

References DataObject\getData().

Section::getReviewFormId ( )

Get ID of primary review form.

Returns
int

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

References DataObject\getData().

Section::getSectionId ( )

Get ID of section.

Returns
int

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

References DataObject\getId(), and Config\getVar().

Section::getSequence ( )

Get sequence of section.

Returns
float

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

References DataObject\getData().

Section::getTitle (   $locale)

Get title of section.

Parameters
$localestring
Returns
string

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

References DataObject\getData().

Section::Section ( )

Constructor.

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

Section::setAbbrev (   $abbrev,
  $locale 
)

Set section title abbreviation.

Parameters
$abbrevstring
$localestring

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

References DataObject\setData().

Section::setAbstractsNotRequired (   $abstractsNotRequired)

Set boolean indicating whether abstracts are required

Parameters
$abstractsNotRequiredboolean

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

References DataObject\setData().

Section::setAbstractWordCount (   $wordCount)

Set abstract word count limit.

Parameters
$wordCountint

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

References DataObject\setData().

Section::setDisableComments (   $disableComments)

Set if RT comments should be disabled.

Parameters
$disableCommentsboolean

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

References DataObject\setData().

Section::setEditorRestricted (   $editorRestricted)

Set whether or not submissions are restricted to [section]Editors.

Parameters
$editorRestrictedboolean

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

References DataObject\setData().

Section::setHideAbout (   $hideAbout)

Set if title should be hidden in About.

Parameters
$hideAboutboolean

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

References DataObject\setData().

Section::setHideAuthor (   $hideAuthor)

Set if author should be hidden in issue ToC.

Parameters
$hideAuthorboolean

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

References DataObject\setData().

Section::setHideTitle (   $hideTitle)

Set if title should be hidden in issue ToC.

Parameters
$hideTitleboolean

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

References DataObject\setData().

Section::setIdentifyType (   $identifyType,
  $locale 
)

Set string identifying type of items in this section.

Parameters
$identifyTypestring
$localestring

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

References DataObject\setData().

Section::setJournalId (   $journalId)

Set ID of journal.

Parameters
$journalIdint

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

References DataObject\setData().

Section::setMetaIndexed (   $metaIndexed)

Set open archive setting of section.

Parameters
$metaIndexedboolean

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

References DataObject\setData().

Section::setMetaReviewed (   $metaReviewed)

Set peer-reviewed setting of section.

Parameters
$metaReviewedboolean

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

References DataObject\setData().

Section::setPolicy (   $policy,
  $locale 
)

Set policy.

Parameters
$policystring
$localestring

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

References DataObject\setData().

Section::setReviewFormId (   $reviewFormId)

Set ID of primary review form.

Parameters
$reviewFormIdint

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

References DataObject\setData().

Section::setSectionId (   $sectionId)

Set ID of section.

Parameters
$sectionIdint

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

References Config\getVar(), and DataObject\setId().

Section::setSequence (   $sequence)

Set sequence of section.

Parameters
$sequencefloat

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

References DataObject\setData().

Section::setTitle (   $title,
  $locale 
)

Set title of section.

Parameters
$titlestring
$localestring

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

References DataObject\setData().


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