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

Public Member Functions

 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.

Definition at line 16 of file PKPSection.inc.php.

Member Function Documentation

◆ getContextId()

PKPSection::getContextId ( )

Get ID of context.

Returns
int

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

References DataObject\getData().

Referenced by Section\getJournalId().

◆ getEditorRestricted()

PKPSection::getEditorRestricted ( )

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

Returns
boolean

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

References DataObject\getData().

◆ getLocalizedPolicy()

PKPSection::getLocalizedPolicy ( )

Get localized section policy.

Returns
string

Definition at line 121 of file PKPSection.inc.php.

References DataObject\getLocalizedData().

◆ getLocalizedTitle()

PKPSection::getLocalizedTitle ( )

Get localized title of section.

Returns
string

Definition at line 54 of file PKPSection.inc.php.

References DataObject\getLocalizedData().

◆ getPolicy()

PKPSection::getPolicy (   $locale)

Get policy.

Parameters
$localestring
Returns
string

Definition at line 130 of file PKPSection.inc.php.

References DataObject\getData().

◆ getReviewFormId()

PKPSection::getReviewFormId ( )

Get ID of primary review form.

Returns
int

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

References DataObject\getData().

◆ getSequence()

PKPSection::getSequence ( )

Get sequence of section.

Returns
float

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

References DataObject\getData().

◆ getTitle()

PKPSection::getTitle (   $locale)

Get title of section.

Parameters
$localestring
Returns
string

Definition at line 63 of file PKPSection.inc.php.

References DataObject\getData().

◆ getViews()

PKPSection::getViews ( )

Get section main page views.

Returns
int

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

References $application, PKPApplication\get(), and DataObject\getId().

◆ setContextId()

PKPSection::setContextId (   $contextId)

Set ID of context.

Parameters
$contextIdint

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

References DataObject\setData().

Referenced by Section\setJournalId().

◆ setEditorRestricted()

PKPSection::setEditorRestricted (   $editorRestricted)

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

Parameters
$editorRestrictedboolean

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

References DataObject\setData().

◆ setPolicy()

PKPSection::setPolicy (   $policy,
  $locale 
)

Set policy.

Parameters
$policystring
$localestring

Definition at line 139 of file PKPSection.inc.php.

References DataObject\setData().

◆ setReviewFormId()

PKPSection::setReviewFormId (   $reviewFormId)

Set ID of primary review form.

Parameters
$reviewFormIdint

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

References DataObject\setData().

◆ setSequence()

PKPSection::setSequence (   $sequence)

Set sequence of section.

Parameters
$sequencefloat

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

References DataObject\setData().

◆ setTitle()

PKPSection::setTitle (   $title,
  $locale 
)

Set title of section.

Parameters
$titlestring
$localestring

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

References DataObject\setData().


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