Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
PKPReviewAssignmentDAO Class Reference
Inheritance diagram for PKPReviewAssignmentDAO:
DAO ReviewAssignmentDAO

Public Member Functions

_fromRow (&$row)
 
 deleteById ($reviewId)
 
 deleteBySubmissionId ($submissionId)
 
getById ($reviewId)
 
getByReviewFormId ($reviewFormId)
 
getBySubmissionId ($submissionId, $round=null, $stageId=null)
 
getByUserId ($userId)
 
getCancelsAndRegrets ($submissionId)
 
getEarliestNotificationByRound ($submissionId)
 
getIncompleteReviewAssignments ()
 
 getIncompleteReviewAssignmentsWhereString ()
 
 getInsertReviewId ()
 
getLastModifiedByRound ($submissionId)
 
getReviewAssignment ($submissionId, $reviewerId, $round, $stageId=null)
 
getReviewerIdsBySubmissionId ($submissionId, $round=null, $stageId=null)
 
getReviewIndexesForRound ($submissionId, $round)
 
 getReviewRoundJoin ()
 
 insertObject (&$reviewAssignment)
 
 newDataObject ()
 
 PKPReviewAssignmentDAO ()
 
 updateReviewAssignment (&$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 ()
 
 getDataChangedEvent ($elementId=null, $parentElementId=null)
 
getDataSource ()
 
 getDirectionMapping ($direction)
 
 getDriver ()
 
 getInsertId ($table= '', $id= '', $callHooks=true)
 
 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

- Public Attributes inherited from DAO
 $_dataSource
 

Detailed Description

Class for DAO relating reviewers to submissions.

See Also
PKPReviewAssignment

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

Member Function Documentation

& PKPReviewAssignmentDAO::_fromRow ( $row)

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

Parameters
$rowarray
Returns
ReviewAssignment

Definition at line 566 of file PKPReviewAssignmentDAO.inc.php.

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

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

PKPReviewAssignmentDAO::deleteById (   $reviewId)

Delete review assignment.

Parameters
$reviewIdint

Definition at line 620 of file PKPReviewAssignmentDAO.inc.php.

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

PKPReviewAssignmentDAO::deleteBySubmissionId (   $submissionId)

Delete review assignments by submission ID.

Parameters
$submissionIdint
Returns
boolean

Definition at line 635 of file PKPReviewAssignmentDAO.inc.php.

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

Referenced by ReviewAssignmentDAO\deleteReviewAssignmentsByArticle().

& PKPReviewAssignmentDAO::getById (   $reviewId)

Retrieve a review assignment by review assignment id.

Parameters
$reviewIdint
Returns
ReviewAssignment

Definition at line 94 of file PKPReviewAssignmentDAO.inc.php.

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

Referenced by ReviewAssignmentDAO\getReviewAssignmentById().

& PKPReviewAssignmentDAO::getByReviewFormId (   $reviewFormId)

Get all review assignments for a review form.

Parameters
$reviewFormIdint
Returns
array ReviewAssignments

Definition at line 290 of file PKPReviewAssignmentDAO.inc.php.

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

Referenced by ReviewAssignmentDAO\getReviewAssignmentsByReviewFormId().

& PKPReviewAssignmentDAO::getBySubmissionId (   $submissionId,
  $round = null,
  $stageId = null 
)

Get all review assignments for a submission.

Parameters
$submissionIdint optional
$stageIdint optional
Returns
array ReviewAssignments

Definition at line 170 of file PKPReviewAssignmentDAO.inc.php.

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

Referenced by ReviewAssignmentDAO\getReviewAssignmentsByArticleId().

& PKPReviewAssignmentDAO::getByUserId (   $userId)

Get all review assignments for a reviewer.

Parameters
$userIdint
Returns
array ReviewAssignments

Definition at line 256 of file PKPReviewAssignmentDAO.inc.php.

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

Referenced by ReviewAssignmentDAO\getReviewAssignmentsByUserId().

& PKPReviewAssignmentDAO::getCancelsAndRegrets (   $submissionId)

Get all cancelled/declined review assignments for a submission.

Parameters
$submissionIdint
Returns
array ReviewAssignments

Definition at line 324 of file PKPReviewAssignmentDAO.inc.php.

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

& PKPReviewAssignmentDAO::getEarliestNotificationByRound (   $submissionId)

Get the first notified date from all review assignments for a round of a submission.

Parameters
$submissionIdint
$roundint
Returns
array Associative array of ($round_num => $earliest_date_of_notification)*

Definition at line 420 of file PKPReviewAssignmentDAO.inc.php.

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

& PKPReviewAssignmentDAO::getIncompleteReviewAssignments ( )

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

Parameters
$articleIdint
Returns
array ReviewAssignments

Definition at line 125 of file PKPReviewAssignmentDAO.inc.php.

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

PKPReviewAssignmentDAO::getIncompleteReviewAssignmentsWhereString ( )

Get the WHERE sql string to filter incomplete review assignments.

Returns
string

Definition at line 157 of file PKPReviewAssignmentDAO.inc.php.

Referenced by getIncompleteReviewAssignments().

PKPReviewAssignmentDAO::getInsertReviewId ( )

Get the ID of the last inserted review assignment.

Returns
int

Definition at line 660 of file PKPReviewAssignmentDAO.inc.php.

References DAO\getInsertId().

Referenced by insertObject().

& PKPReviewAssignmentDAO::getLastModifiedByRound (   $submissionId)

Get the most recent last modified date for all review assignments for each round of a submission.

Parameters
$submissionIdint
$roundint
Returns
array associating round with most recent last modified date

Definition at line 391 of file PKPReviewAssignmentDAO.inc.php.

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

& PKPReviewAssignmentDAO::getReviewAssignment (   $submissionId,
  $reviewerId,
  $round,
  $stageId = null 
)

Retrieve a review assignment by reviewer and submission.

Parameters
$submissionIdint
$reviewerIdint
$roundint
$stageIdint optional
Returns
ReviewAssignment

Definition at line 57 of file PKPReviewAssignmentDAO.inc.php.

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

& PKPReviewAssignmentDAO::getReviewerIdsBySubmissionId (   $submissionId,
  $round = null,
  $stageId = null 
)

Get the IDs of all reviewers assigned to a submission.

Parameters
$submissionIdint
$roundint optional
$stageIdint optional
Returns
array ReviewAssignments

Definition at line 219 of file PKPReviewAssignmentDAO.inc.php.

References DAO\retrieve().

& PKPReviewAssignmentDAO::getReviewIndexesForRound (   $submissionId,
  $round 
)

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

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

Definition at line 360 of file PKPReviewAssignmentDAO.inc.php.

References DAO\retrieve().

PKPReviewAssignmentDAO::getReviewRoundJoin ( )

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

Returns
string

Definition at line 40 of file PKPReviewAssignmentDAO.inc.php.

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

PKPReviewAssignmentDAO::insertObject ( $reviewAssignment)

Insert a new Review Assignment.

Parameters
$reviewAssignmentReviewAssignment

Definition at line 452 of file PKPReviewAssignmentDAO.inc.php.

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

PKPReviewAssignmentDAO::newDataObject ( )

Return a new review assignment data object.

Returns
DataObject

Definition at line 607 of file PKPReviewAssignmentDAO.inc.php.

Referenced by _fromRow().

PKPReviewAssignmentDAO::PKPReviewAssignmentDAO ( )

Constructor.

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

References DAORegistry\getDAO().

PKPReviewAssignmentDAO::updateReviewAssignment ( $reviewAssignment)

Update an existing review assignment.

Parameters
$reviewAssignmentobject

Definition at line 506 of file PKPReviewAssignmentDAO.inc.php.

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


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