Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
ReviewAssignmentDAO Class Reference
Inheritance diagram for ReviewAssignmentDAO:
DAO

Public Member Functions

 _fromRow ($row)
 
 _getReviewAssignmentsArray ($query, $queryParams)
 
 _getSelectQuery ()
 
 deleteById ($reviewId)
 
 deleteBySubmissionId ($submissionId)
 
 getAnonymousReviewerStatistics ()
 
 getById ($reviewId)
 
 getByReviewFormId ($reviewFormId)
 
 getByReviewRoundId ($reviewRoundId, $excludeCancelled=false)
 
 getBySubmissionId ($submissionId, $reviewRoundId=null, $stageId=null)
 
 getByUserId ($userId)
 
 getCancelsAndRegrets ($submissionId)
 
 getIncompleteReviewAssignments ()
 
 getIncompleteReviewAssignmentsWhereString ()
 
 getInsertId ()
 
 getLastReviewRoundReviewAssignmentByReviewer ($submissionId, $reviewerId)
 
 getReviewAssignment ($reviewRoundId, $reviewerId)
 
 getReviewerStatistics ($contextId)
 
 getReviewIndexesForRound ($submissionId, $reviewRoundId)
 
 getReviewMethodsTranslationKeys ()
 
 getReviewRoundJoin ()
 
 insertObject ($reviewAssignment)
 
 newDataObject ()
 
 ReviewAssignmentDAO ()
 
 reviewerExists ($reviewRoundId, $reviewerId)
 
 updateObject ($reviewAssignment)
 
- Public Member Functions inherited from DAO
 concat ()
 
 convertFromDB ($value, $type)
 
 convertToDB ($value, &$type)
 
 DAO ($dataSource=null, $callHooks=true)
 
 dateFromDB ($d)
 
 datetimeFromDB ($dt)
 
 datetimeToDB ($dt)
 
 dateToDB ($d)
 
 flushCache ()
 
 formatDateToDB ($date, $defaultNumWeeks=null, $acceptPastDate=true)
 
 getAffectedRows ()
 
getDataSource ()
 
 getDirectionMapping ($direction)
 
 getDriver ()
 
 getType ($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)
 
- Public Attributes inherited from DAO
 $_dataSource
 
- 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.

Member Function Documentation

ReviewAssignmentDAO::_fromRow (   $row)
ReviewAssignmentDAO::_getReviewAssignmentsArray (   $query,
  $queryParams 
)

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

Parameters
$querystring
$queryParamsarray
Returns
array

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

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

Referenced by getByReviewRoundId(), and getBySubmissionId().

ReviewAssignmentDAO::_getSelectQuery ( )

Get sql query to select review assignments.

Returns
string

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

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

ReviewAssignmentDAO::deleteById (   $reviewId)

Delete review assignment.

Parameters
$reviewIdint

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

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

Referenced by deleteBySubmissionId().

ReviewAssignmentDAO::deleteBySubmissionId (   $submissionId)

Delete review assignments by submission ID.

Parameters
$submissionIdint
Returns
boolean

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

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

ReviewAssignmentDAO::getAnonymousReviewerStatistics ( )

Get the number of reviews done, avg. number of days per review, days since last review, and num. of active reviews for all reviewers of the given context.

Returns
array

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

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

ReviewAssignmentDAO::getById (   $reviewId)

Retrieve a review assignment by review assignment id.

Parameters
$reviewIdint
Returns
ReviewAssignment

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

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

ReviewAssignmentDAO::getByReviewFormId (   $reviewFormId)

Get all review assignments for a review form.

Parameters
$reviewFormIdint
Returns
array ReviewAssignments

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

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

ReviewAssignmentDAO::getByReviewRoundId (   $reviewRoundId,
  $excludeCancelled = false 
)

Retrieve review assignments for the passed review round id.

Parameters
$reviewRoundIdint
$excludeCancelledboolean
Returns
array

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

References _getReviewAssignmentsArray(), and _getSelectQuery().

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

Get all review assignments for a submission.

Parameters
$submissionIdint Submission ID
$reviewRoundIdint Review round ID
$stageIdint Optional stage ID
Returns
array ReviewAssignments

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

References _getReviewAssignmentsArray(), and _getSelectQuery().

ReviewAssignmentDAO::getByUserId (   $userId)

Get all review assignments for a reviewer.

Parameters
$userIdint
Returns
array ReviewAssignments

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

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

ReviewAssignmentDAO::getCancelsAndRegrets (   $submissionId)

Get all cancelled/declined review assignments for a submission.

Parameters
$submissionIdint
Returns
array ReviewAssignments

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

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

ReviewAssignmentDAO::getIncompleteReviewAssignments ( )

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

Parameters
$articleIdint
Returns
array ReviewAssignments

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

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

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().

ReviewAssignmentDAO::getInsertId ( )

Get the ID of the last inserted review assignment.

Returns
int

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

References DAO\_getInsertId().

Referenced by insertObject().

ReviewAssignmentDAO::getLastReviewRoundReviewAssignmentByReviewer (   $submissionId,
  $reviewerId 
)

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

Parameters
$submissionIdint
$reviewerIdint
Returns
ReviewAssignment

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

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

ReviewAssignmentDAO::getReviewAssignment (   $reviewRoundId,
  $reviewerId 
)

Retrieve a review assignment by review round and reviewer.

Parameters
$reviewRoundIdint
$reviewerIdint
Returns
ReviewAssignment

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

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

ReviewAssignmentDAO::getReviewerStatistics (   $contextId)

Get the last assigned and last completed dates for all reviewers of the given context.

Parameters
$contextIdint
Returns
array

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

References DAO\datetimeFromDB(), DAORegistry\getDAO(), and DAO\retrieve().

ReviewAssignmentDAO::getReviewIndexesForRound (   $submissionId,
  $reviewRoundId 
)

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

Parameters
$submissionIdint Submission ID
$reviewRoundIdint Review round ID
Returns
array Associating review ID with number, i.e. if review ID 26 is first returned['26']=0.

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

References DAO\retrieve().

ReviewAssignmentDAO::getReviewMethodsTranslationKeys ( )

Return the review methods translation keys.

Returns
array

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

ReviewAssignmentDAO::getReviewRoundJoin ( )

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

Returns
string

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

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

ReviewAssignmentDAO::insertObject (   $reviewAssignment)

Insert a new Review Assignment.

Parameters
$reviewAssignmentReviewAssignment

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

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

ReviewAssignmentDAO::newDataObject ( )

Return a new review assignment data object.

Returns
DataObject

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

Referenced by _fromRow().

ReviewAssignmentDAO::ReviewAssignmentDAO ( )

Constructor.

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

References DAORegistry\getDAO().

ReviewAssignmentDAO::reviewerExists (   $reviewRoundId,
  $reviewerId 
)

Check if a reviewer is assigned to a specified submisssion.

Parameters
$reviewRoundIdint
$reviewerIdint
Returns
boolean

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

References DAO\retrieve().

ReviewAssignmentDAO::updateObject (   $reviewAssignment)

Update an existing review assignment.

Parameters
$reviewAssignmentobject

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

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


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