Inheritance diagram for ReviewRoundDAO:

Public Member Functions
	_fromRow ($row)

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

	deleteById ($reviewRoundId)

	deleteBySubmissionId ($submissionId)

	deleteObject ($reviewRound)

	getById ($reviewRoundId)

	getBySubmissionFileId ($submissionFileId)

	getBySubmissionId ($submissionId, $stageId=null, $round=null)

	getCurrentRoundBySubmissionId ($submissionId, $stageId=null)

	getInsertId ()

	getLastReviewRoundBySubmissionId ($submissionId, $stageId=null)

	getReviewRound ($submissionId, $stageId, $round)

	insertObject ($reviewRound)

	newDataObject ()

	updateObject ($reviewRound)

	updateStatus ($reviewRound, $status=null)

Public Member Functions inherited from DAO
	__construct ($dataSource=null, $callHooks=true)

	concat ()

	convertFromDB ($value, $type)

	convertToDB ($value, &$type)

	dateFromDB ($d)

	datetimeFromDB ($dt)

	datetimeToDB ($dt)

	dateToDB ($d)

	flushCache ()

	formatDateToDB ($date, $defaultNumWeeks=null, $acceptPastDate=true)

	getAdditionalFieldNames ()

	getAffectedRows ()

	getDataObjectSettings ($tableName, $idFieldName, $idFieldValue, $dataObject)

	getDataSource ()

	getDirectionMapping ($direction)

	getDriver ()

	getLocaleFieldNames ()

	getType ($value)

	handleError ($dataSource, $sql)

	nullOrInt ($value)

	replace ($table, $arrFields, $keyCols)

&	retrieve ($sql, $params=false, $callHooks=true)

&	retrieveCached ($sql, $params=false, $secsToCache=3600, $callHooks=true)

&	retrieveLimit ($sql, $params=false, $numRows=false, $offset=false, $callHooks=true)

&	retrieveRange ($sql, $params=false, $dbResultRange=null, $callHooks=true)

	setCacheDir ()

	setDataSource ($dataSource)

	update ($sql, $params=false, $callHooks=true, $dieOnError=true)

	updateDataObjectSettings ($tableName, $dataObject, $idArray)

Additional Inherited Members
Static Public Member Functions inherited from DAO
static	getDataChangedEvent ($elementId=null, $parentElementId=null, $content='')

Data Fields inherited from DAO
	$_dataSource

Protected Member Functions inherited from DAO
	_getInsertId ($table='', $id='')

Detailed Description

Operations for retrieving and modifying ReviewRound objects.

See also: ReviewRound

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

Member Function Documentation

◆ _fromRow()

ReviewRoundDAO::_fromRow ( $row )

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

Parameters

$row array

Returns: ReviewRound

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

References newDataObject().

Referenced by getById(), getBySubmissionFileId(), getLastReviewRoundBySubmissionId(), and getReviewRound().

◆ build()

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 32 of file ReviewRoundDAO.inc.php.

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

◆ deleteById()

ReviewRoundDAO::deleteById ( $reviewRoundId )

Delete a review round by ID.

Parameters

$reviewRoundId int

Returns: boolean

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

References DAO\update().

Referenced by deleteObject().

◆ deleteBySubmissionId()

ReviewRoundDAO::deleteBySubmissionId ( $submissionId )

Delete review rounds by submission ID.

Parameters

$submissionId int

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

References deleteObject(), and getBySubmissionId().

◆ deleteObject()

ReviewRoundDAO::deleteObject ( $reviewRound )

Delete a review round.

Parameters

$reviewRound ReviewRound

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

References deleteById().

Referenced by deleteBySubmissionId().

◆ getById()

ReviewRoundDAO::getById ( $reviewRoundId )

Retrieve a review round by its id.

Parameters

int $reviewRoundId

Returns: ReviewRound

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

References _fromRow(), and DAO\retrieve().

◆ getBySubmissionFileId()

ReviewRoundDAO::getBySubmissionFileId ( $submissionFileId )

Retrieve a review round by a submission file id.

Parameters

$submissionFileId int

Returns: ReviewRound

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

References _fromRow(), and DAO\retrieve().

◆ getBySubmissionId()

ReviewRoundDAO::getBySubmissionId	(	$submissionId,
		$stageId = `null`,
		$round = `null`
	)

Get an iterator of review round objects associated with this submission

Parameters

$submissionId	int
$stageId	int (optional)
$round	int (optional)

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

References DAO\retrieve().

Referenced by deleteBySubmissionId().

◆ getCurrentRoundBySubmissionId()

ReviewRoundDAO::getCurrentRoundBySubmissionId	(	$submissionId,
		$stageId = `null`
	)

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

Parameters

$submissionId	int
$stageId	int

Returns: int

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

References DAO\retrieve().

◆ getInsertId()

ReviewRoundDAO::getInsertId ( )

Get the ID of the last inserted review round.

Returns: int

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

References DAO\_getInsertId().

Referenced by build().

◆ getLastReviewRoundBySubmissionId()

ReviewRoundDAO::getLastReviewRoundBySubmissionId	(	$submissionId,
		$stageId = `null`
	)

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

Parameters

$submissionId	int
$stageId	int

Returns: ReviewRound

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

References _fromRow(), and DAO\retrieveLimit().

◆ getReviewRound()

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 115 of file ReviewRoundDAO.inc.php.

References _fromRow(), and DAO\retrieve().

Referenced by build().

◆ insertObject()

ReviewRoundDAO::insertObject ( $reviewRound )

Insert a new review round.

Parameters

$reviewRound ReviewRound

Returns: int

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

References DAO\update().

Referenced by build().

◆ newDataObject()

ReviewRoundDAO::newDataObject ( )

Construct a new data object corresponding to this DAO.

Returns: ReviewRound

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

Referenced by _fromRow(), and build().

◆ updateObject()

ReviewRoundDAO::updateObject ( $reviewRound )

Update an existing review round.

Parameters

$reviewRound ReviewRound

Returns: boolean

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

References DAO\update().

◆ updateStatus()

ReviewRoundDAO::updateStatus	(	$reviewRound,
		$status = `null`
	)

Update the review round status.

Parameters

$reviewRound	ReviewRound
$status	int? Optionally pass a REVIEW_ROUND_STATUS_... to set a specific status. If not included, will determine the appropriate status based on ReviewRound::determineStatus().

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

References DAO\update().

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

ReviewRoundDAO.inc.php

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _fromRow()

◆ build()

◆ deleteById()

◆ deleteBySubmissionId()

◆ deleteObject()

◆ getById()

◆ getBySubmissionFileId()

◆ getBySubmissionId()

◆ getCurrentRoundBySubmissionId()

◆ getInsertId()

◆ getLastReviewRoundBySubmissionId()

◆ getReviewRound()

◆ insertObject()

◆ newDataObject()

◆ updateObject()

◆ updateStatus()