Open Journal Systems  3.3.0
ReviewRound Class Reference
Inheritance diagram for ReviewRound:
DataObject

Public Member Functions

 determineStatus ()
 
 getRound ()
 
 getStageId ()
 
 getStatus ()
 
 getStatusKey ($isAuthor=false)
 
 getSubmissionId ()
 
 setRound ($round)
 
 setStageId ($stageId)
 
 setStatus ($status)
 
 setSubmissionId ($submissionId)
 
- 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

Basic class describing a review round.

See also
ReviewRoundDAO

Definition at line 48 of file ReviewRound.inc.php.

Member Function Documentation

◆ determineStatus()

ReviewRound::determineStatus ( )

Calculate the status of this review round.

If the round is in revisions, it will search for revision files and set the status accordingly. If the round has not reached a revision status yet, it will determine the status based on the statuses of the round's ReviewAssignments.

Returns
int

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

References DAORegistry\getDAO(), DataObject\getId(), getRound(), getStageId(), getStatus(), and getSubmissionId().

Referenced by getStatusKey().

◆ getRound()

ReviewRound::getRound ( )

Get review round

Returns
int

Definition at line 90 of file ReviewRound.inc.php.

References DataObject\getData().

Referenced by determineStatus().

◆ getStageId()

ReviewRound::getStageId ( )

Get review stage id (internal or external review).

Returns
int

Definition at line 74 of file ReviewRound.inc.php.

References DataObject\getData().

Referenced by determineStatus().

◆ getStatus()

ReviewRound::getStatus ( )

Get current round status

Returns
int

Definition at line 106 of file ReviewRound.inc.php.

References DataObject\getData().

Referenced by determineStatus().

◆ getStatusKey()

ReviewRound::getStatusKey (   $isAuthor = false)

Get locale key associated with current status

Parameters
$isAuthorboolean True iff the status is to be shown to the author (slightly tweaked phrasing)
Returns
int

Definition at line 258 of file ReviewRound.inc.php.

References determineStatus().

◆ getSubmissionId()

ReviewRound::getSubmissionId ( )

get submission id

Returns
int

Definition at line 58 of file ReviewRound.inc.php.

References DataObject\getData().

Referenced by determineStatus().

◆ setRound()

ReviewRound::setRound (   $round)

Set review round

Parameters
$assocTypeint

Definition at line 98 of file ReviewRound.inc.php.

References DataObject\setData().

◆ setStageId()

ReviewRound::setStageId (   $stageId)

Set review stage id

Parameters
$stageIdint

Definition at line 82 of file ReviewRound.inc.php.

References DataObject\setData().

◆ setStatus()

ReviewRound::setStatus (   $status)

Set current round status

Parameters
$statusint

Definition at line 114 of file ReviewRound.inc.php.

References DataObject\setData().

◆ setSubmissionId()

ReviewRound::setSubmissionId (   $submissionId)

set submission id

Parameters
$submissionIdint

Definition at line 66 of file ReviewRound.inc.php.

References DataObject\setData().


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