Inheritance diagram for ReviewAssignmentDAO:

Public Member Functions
	__construct ()

	_fromRow ($row)

	_getReviewAssignmentsArray ($query, $queryParams)

	_getSelectQuery ()

	deleteById ($reviewId)

	deleteBySubmissionId ($submissionId)

	getById ($reviewId)

	getByReviewFormId ($reviewFormId)

	getByReviewRoundId ($reviewRoundId)

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

	getByUserId ($userId)

	getIncompleteReviewAssignments ()

	getIncompleteReviewAssignmentsWhereString ()

	getInsertId ()

	getLastReviewRoundReviewAssignmentByReviewer ($submissionId, $reviewerId)

	getOpenReviewsByReviewRoundId ($reviewRoundId)

	getReviewAssignment ($reviewRoundId, $reviewerId)

	getReviewIndexesForRound ($submissionId, $reviewRoundId)

	getReviewMethodsTranslationKeys ()

	getReviewRoundJoin ()

	insertObject ($reviewAssignment)

	newDataObject ()

	reviewerExists ($reviewRoundId, $reviewerId)

	updateObject ($reviewAssignment)

	updateReviewRoundStatus ($reviewAssignment)

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)

Data Fields
	$userDao

Data Fields inherited from DAO
	$_dataSource

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

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

Detailed Description

Class for DAO relating reviewers to submissions.

See also: ReviewAssignment

Definition at line 20 of file ReviewAssignmentDAO.inc.php.

Constructor & Destructor Documentation

◆ __construct()

ReviewAssignmentDAO::__construct ( )

Constructor.

Definition at line 26 of file ReviewAssignmentDAO.inc.php.

References DAORegistry\getDAO().

Member Function Documentation

◆ _fromRow()

ReviewAssignmentDAO::_fromRow ( $row )

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

Parameters

$row array

Returns: ReviewAssignment

Definition at line 478 of file ReviewAssignmentDAO.inc.php.

References DAO\datetimeFromDB(), and newDataObject().

Referenced by _getReviewAssignmentsArray(), getById(), getByReviewFormId(), getByUserId(), getIncompleteReviewAssignments(), getLastReviewRoundReviewAssignmentByReviewer(), and getReviewAssignment().

◆ _getReviewAssignmentsArray()

ReviewAssignmentDAO::_getReviewAssignmentsArray	(	$query,
		$queryParams
	)

Retrieve review assignments from table usign the passed sql query and parameters.

Parameters

$query	string
$queryParams	array

Returns: array

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

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

Referenced by getByReviewRoundId(), getBySubmissionId(), and getOpenReviewsByReviewRoundId().

◆ _getSelectQuery()

ReviewAssignmentDAO::_getSelectQuery ( )

Get sql query to select review assignments.

Returns: string

Definition at line 626 of file ReviewAssignmentDAO.inc.php.

Referenced by getByReviewRoundId(), getBySubmissionId(), getLastReviewRoundReviewAssignmentByReviewer(), getOpenReviewsByReviewRoundId(), and getReviewAssignment().

◆ deleteById()

ReviewAssignmentDAO::deleteById ( $reviewId )

Delete review assignment.

Parameters

$reviewId int

Definition at line 524 of file ReviewAssignmentDAO.inc.php.

References getById(), DAORegistry\getDAO(), DAO\update(), and updateReviewRoundStatus().

Referenced by deleteBySubmissionId().

◆ deleteBySubmissionId()

ReviewAssignmentDAO::deleteBySubmissionId ( $submissionId )

Delete review assignments by submission ID.

Parameters

$submissionId int

Returns: boolean

Definition at line 554 of file ReviewAssignmentDAO.inc.php.

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

◆ getById()

ReviewAssignmentDAO::getById ( $reviewId )

Retrieve a review assignment by review assignment id.

Parameters

$reviewId int

Returns: ReviewAssignment

Definition at line 122 of file ReviewAssignmentDAO.inc.php.

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

Referenced by deleteById().

◆ getByReviewFormId()

ReviewAssignmentDAO::getByReviewFormId ( $reviewFormId )

Get all review assignments for a review form.

Parameters

$reviewFormId int

Returns: array ReviewAssignments

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

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

◆ getByReviewRoundId()

ReviewAssignmentDAO::getByReviewRoundId ( $reviewRoundId )

Retrieve review assignments for the passed review round id.

Parameters

$reviewRoundId int

Returns: array

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

References _getReviewAssignmentsArray(), and _getSelectQuery().

◆ getBySubmissionId()

ReviewAssignmentDAO::getBySubmissionId	(	$submissionId,
		$reviewRoundId = `null`,
		$stageId = `null`
	)

Get all review assignments for a submission.

Parameters

$submissionId	int Submission ID
$reviewRoundId	int Review round ID
$stageId	int Optional stage ID

Returns: array ReviewAssignments

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

References _getReviewAssignmentsArray(), and _getSelectQuery().

◆ getByUserId()

ReviewAssignmentDAO::getByUserId ( $userId )

Get all review assignments for a reviewer.

Parameters

$userId int

Returns: array ReviewAssignments

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

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

◆ getIncompleteReviewAssignments()

ReviewAssignmentDAO::getIncompleteReviewAssignments ( )

Get all incomplete review assignments for all journals/conferences/presses

Parameters

$articleId int

Returns: array ReviewAssignments

Definition at line 150 of file ReviewAssignmentDAO.inc.php.

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

◆ getIncompleteReviewAssignmentsWhereString()

ReviewAssignmentDAO::getIncompleteReviewAssignmentsWhereString ( )

Get the WHERE sql string to filter incomplete review assignments.

Returns: string

Definition at line 180 of file ReviewAssignmentDAO.inc.php.

Referenced by getIncompleteReviewAssignments().

◆ getInsertId()

ReviewAssignmentDAO::getInsertId ( )

Get the ID of the last inserted review assignment.

Returns: int

Definition at line 575 of file ReviewAssignmentDAO.inc.php.

References DAO\_getInsertId().

Referenced by insertObject().

◆ getLastReviewRoundReviewAssignmentByReviewer()

ReviewAssignmentDAO::getLastReviewRoundReviewAssignmentByReviewer	(	$submissionId,
		$reviewerId
	)

Get the last review round review assignment for a given user.

Parameters

$submissionId	int
$reviewerId	int

Returns: ReviewAssignment

Definition at line 585 of file ReviewAssignmentDAO.inc.php.

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

◆ getOpenReviewsByReviewRoundId()

ReviewAssignmentDAO::getOpenReviewsByReviewRoundId ( $reviewRoundId )

Retrieve open review assignments for the passed review round id.

Parameters

$reviewRoundId int

Returns: array

Definition at line 49 of file ReviewAssignmentDAO.inc.php.

References _getReviewAssignmentsArray(), and _getSelectQuery().

◆ getReviewAssignment()

ReviewAssignmentDAO::getReviewAssignment	(	$reviewRoundId,
		$reviewerId
	)

Retrieve a review assignment by review round and reviewer.

Parameters

$reviewRoundId	int
$reviewerId	int

Returns: ReviewAssignment

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

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

◆ getReviewIndexesForRound()

ReviewAssignmentDAO::getReviewIndexesForRound	(	$submissionId,
		$reviewRoundId
	)

Determine the order of active reviews for the given round of the given submission

Parameters

$submissionId	int Submission ID
$reviewRoundId	int Review round ID

Returns: array Associating review ID with number, i.e. if review ID 26 is first returned['26']=0.

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

References DAO\retrieve().

◆ getReviewMethodsTranslationKeys()

ReviewAssignmentDAO::getReviewMethodsTranslationKeys ( )

Return the review methods translation keys.

Returns: array

Definition at line 613 of file ReviewAssignmentDAO.inc.php.

References AppLocale\requireComponents().

◆ getReviewRoundJoin()

ReviewAssignmentDAO::getReviewRoundJoin ( )

Get the review_rounds join string. Must be implemented by subclasses.

Returns: string

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

Referenced by getById(), getByReviewFormId(), getByUserId(), and getIncompleteReviewAssignments().

◆ insertObject()

ReviewAssignmentDAO::insertObject ( $reviewAssignment )

Insert a new Review Assignment.

Parameters

$reviewAssignment ReviewAssignment

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

References DAO\datetimeToDB(), getInsertId(), DAO\update(), and updateReviewRoundStatus().

◆ newDataObject()

ReviewAssignmentDAO::newDataObject ( )

Return a new review assignment data object.

Returns: DataObject

Definition at line 516 of file ReviewAssignmentDAO.inc.php.

Referenced by _fromRow().

◆ reviewerExists()

ReviewAssignmentDAO::reviewerExists	(	$reviewRoundId,
		$reviewerId
	)

Check if a reviewer is assigned to a specified submission.

Parameters

$reviewRoundId	int
$reviewerId	int

Returns: boolean

Definition at line 259 of file ReviewAssignmentDAO.inc.php.

References DAO\retrieve().

◆ updateObject()

ReviewAssignmentDAO::updateObject ( $reviewAssignment )

Update an existing review assignment.

Parameters

$reviewAssignment object

Definition at line 398 of file ReviewAssignmentDAO.inc.php.

References DAO\datetimeToDB(), DAO\update(), and updateReviewRoundStatus().

◆ updateReviewRoundStatus()

ReviewAssignmentDAO::updateReviewRoundStatus ( $reviewAssignment )

Update the status of the review round an assignment is attached to. This should be fired whenever a reviewer assignment is modified.

Parameters

$reviewAssignment ReviewAssignment

Definition at line 456 of file ReviewAssignmentDAO.inc.php.

References DAORegistry\getDAO().

Referenced by deleteById(), insertObject(), and updateObject().

Field Documentation

◆ $userDao

ReviewAssignmentDAO::$userDao

Definition at line 21 of file ReviewAssignmentDAO.inc.php.

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

ReviewAssignmentDAO.inc.php

Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _fromRow()

◆ _getReviewAssignmentsArray()

◆ _getSelectQuery()

◆ deleteById()

◆ deleteBySubmissionId()

◆ getById()

◆ getByReviewFormId()

◆ getByReviewRoundId()

◆ getBySubmissionId()

◆ getByUserId()

◆ getIncompleteReviewAssignments()

◆ getIncompleteReviewAssignmentsWhereString()

◆ getInsertId()

◆ getLastReviewRoundReviewAssignmentByReviewer()

◆ getOpenReviewsByReviewRoundId()

◆ getReviewAssignment()

◆ getReviewIndexesForRound()

◆ getReviewMethodsTranslationKeys()

◆ getReviewRoundJoin()

◆ insertObject()

◆ newDataObject()

◆ reviewerExists()

◆ updateObject()

◆ updateReviewRoundStatus()

Field Documentation

◆ $userDao