ReviewRoundDAO Class Reference [Monograph_reviewRound]

Operations for retrieving and modifying ReviewRound objects. More...

List of all members.

Public Member Functions
&	_fromRow (&$row)
	build ($submissionId, $stageId, $round, $status=null)
&	getByMonographFileId ($monographFileId)
&	getByMonographId ($monographId, $stageId=null, $round=null)
	getCurrentRoundByMonographId ($monographId, $stageId=null)
	getEditorDecisionRoundStatus ()
	getInsertReviewRoundId ()
&	getLastReviewRoundByMonographId ($monographId, $stageId=null)
	getReviewRound ($submissionId, $stageId, $round)
&	getReviewRoundById ($reviewRoundId)
	insertObject (&$reviewRound)
	newDataObject ()
	ReviewRoundDAO ()
	reviewRoundExists ($monographId, $stageId, $round)
	updateObject (&$reviewRound)
	updateStatus (&$reviewRound, $reviewAssignments=array(), $status=null)

---

Detailed Description

Operations for retrieving and modifying ReviewRound objects.

See also:

ReviewRound

Definition at line 18 of file ReviewRoundDAO.inc.php.

---

Member Function Documentation

& ReviewRoundDAO._fromRow

(

&$

row

)

Internal function to return a review round object from a row.

Parameters:

$row

array

Returns:

Signoff

Definition at line 370 of file ReviewRoundDAO.inc.php.

References newDataObject().

Referenced by getByMonographFileId(), getLastReviewRoundByMonographId(), getReviewRound(), and getReviewRoundById().

ReviewRoundDAO.build	(	$	submissionId,
		$	stageId,
		$	round,
		$	status = null
	)

Fetch a review round, creating it if needed.

Parameters:

	$submissionId	integer
	$stageId	integer One of the WORKFLOW_*_REVIEW_STAGE_ID constants.
	$round	integer
	$status	integer One of the REVIEW_ROUND_STATUS_* constants.

Returns:

ReviewRound

Definition at line 37 of file ReviewRoundDAO.inc.php.

References getInsertReviewRoundId(), getReviewRound(), insertObject(), and newDataObject().

& ReviewRoundDAO.getByMonographFileId

(

$

monographFileId

)

Retrieve a review round by a monograph file id.

Parameters:

$monographFileId

int

Returns:

ReviewRound

Definition at line 155 of file ReviewRoundDAO.inc.php.

References _fromRow().

& ReviewRoundDAO.getByMonographId	(	$	monographId,
		$	stageId = null,
		$	round = null
	)

Get an iterator of review round objects associated with this monograph

Parameters:

	$monographId	int
	$stageId	int (optional)
	$round	int (optional)

Definition at line 195 of file ReviewRoundDAO.inc.php.

ReviewRoundDAO.getCurrentRoundByMonographId	(	$	monographId,
		$	stageId = null
	)

Get the current review round for a given stage (or for the latest stage)

Parameters:

	$monographId	int
	$stageId	int

Returns:

int

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

ReviewRoundDAO.getEditorDecisionRoundStatus

(

)

Return review round status that are related with editor decisions.

Returns:

array

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

Referenced by updateStatus().

ReviewRoundDAO.getInsertReviewRoundId

(

)

Get the ID of the last inserted review round.

Returns:

int

Definition at line 262 of file ReviewRoundDAO.inc.php.

Referenced by build().

& ReviewRoundDAO.getLastReviewRoundByMonographId	(	$	monographId,
		$	stageId = null
	)

Get the last review round for a give stage (or for the latest stage)

Parameters:

	$monographId	int
	$stageId	int

Returns:

ReviewRound

Definition at line 237 of file ReviewRoundDAO.inc.php.

References _fromRow().

Referenced by updateStatus().

ReviewRoundDAO.getReviewRound	(	$	submissionId,
		$	stageId,
		$	round
	)

Retrieve a review round

Parameters:

	$submissionId	integer
	$stageId	int One of the Stage_id_* constants.
	$round	int The review round to be retrieved.

Definition at line 119 of file ReviewRoundDAO.inc.php.

References _fromRow().

Referenced by build().

& ReviewRoundDAO.getReviewRoundById

(

$

reviewRoundId

)

Retrieve a review round by its id.

Parameters:

int

$reviewRoundId

Returns:

ReviewRound

Definition at line 137 of file ReviewRoundDAO.inc.php.

References _fromRow().

ReviewRoundDAO.insertObject

(

&$

reviewRound

)

Insert a new review round.

Parameters:

$reviewRound

ReviewRound

Returns:

int

Definition at line 75 of file ReviewRoundDAO.inc.php.

Referenced by build().

ReviewRoundDAO.newDataObject

(

)

Construct a new data object corresponding to this DAO.

Returns:

SignoffEntry

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

Referenced by _fromRow(), and build().

ReviewRoundDAO.ReviewRoundDAO

(

)

Constructor

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

ReviewRoundDAO.reviewRoundExists	(	$	monographId,
		$	stageId,
		$	round
	)

Check if a review round exists for a specified monograph.

Parameters:

	$monographId	int
	$round	int

Returns:

boolean

Definition at line 177 of file ReviewRoundDAO.inc.php.

ReviewRoundDAO.updateObject

(

&$

reviewRound

)

Update an existing review round.

Parameters:

$reviewRound

ReviewRound

Returns:

boolean

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

ReviewRoundDAO.updateStatus	(	&$	reviewRound,
		$	reviewAssignments = array(),
		$	status = null
	)

FIXME #7386# Update the review round status. If review assignments is passed and no status, then this method will find the correct review round status based on the review round assignments state.

Parameters:

	$reviewRound	ReviewRound
	$reviewAssignments	array Review round review assignments.
	$status	int

Definition at line 275 of file ReviewRoundDAO.inc.php.

References getEditorDecisionRoundStatus(), and getLastReviewRoundByMonographId().

---

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

• classes/monograph/reviewRound/ReviewRoundDAO.inc.php