Public Member Functions

SeriesEditorSubmissionDAO Class Reference

Operations for retrieving and modifying SeriesEditorSubmission objects. FIXME #5557: We need a general code cleanup here (remove useless functions), and to integrate with monograph_stage_assignments table. More...

Inheritance diagram for SeriesEditorSubmissionDAO:
MonographDAO

List of all members.

Public Member Functions

& _fromRow (&$row)
& _returnReviewerUserFromRow (&$row)
 _updateEditorDecision ($monographId, $editorDecision, $stageId=null, $reviewRound=null)
 deleteDecisionsByMonograph ($monographId)
 deleteReviewRoundsByMonograph ($monographId)
& getAllReviewers ($pressId)
 getAnonymousReviewerStatistics ()
& getById ($monographId)
 getEditorDecisions ($monographId, $stageId=null, $round=null)
 getFilteredReviewers ($pressId, $doneMin, $doneMax, $avgMin, $avgMax, $lastMin, $lastMax, $activeMin, $activeMax, $interests, $monographId=null, $reviewRoundId=null)
& getReviewersForMonograph ($pressId, $monographId, $round)
& getReviewersNotAssignedToMonograph ($pressId, $monographId, &$reviewRound, $name= '')
 getReviewerStatistics ($pressId)
 newDataObject ()
 reviewerExists ($reviewRoundId, $reviewerId)
 SeriesEditorSubmissionDAO ()
 transferEditorDecisions ($oldUserId, $newUserId)
 updateSeriesEditorSubmission (&$seriesEditorSubmission)

Detailed Description

Operations for retrieving and modifying SeriesEditorSubmission objects. FIXME #5557: We need a general code cleanup here (remove useless functions), and to integrate with monograph_stage_assignments table.

See also:
SeriesEditorSubmission

Definition at line 23 of file SeriesEditorSubmissionDAO.inc.php.

Member Function Documentation

& SeriesEditorSubmissionDAO._fromRow ( &$  row  ) 

Internal function to return a SeriesEditorSubmission object from a row.

Parameters:
$row array
Returns:
SeriesEditorSubmission

Reimplemented from MonographDAO.

Definition at line 100 of file SeriesEditorSubmissionDAO.inc.php.

References getEditorDecisions().

Referenced by getById().

& SeriesEditorSubmissionDAO._returnReviewerUserFromRow ( &$  row  ) 

FIXME: Document. FIXME: Move to UserDAO, see #6455.

Parameters:
$row 

Definition at line 379 of file SeriesEditorSubmissionDAO.inc.php.

SeriesEditorSubmissionDAO._updateEditorDecision ( $  monographId,
$  editorDecision,
$  stageId = null,
$  reviewRound = null 
)

Update the editor decision table.

Parameters:
$monographId int
$editorDecision array
$reviewRound ReviewRound (optional)

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

Referenced by updateSeriesEditorSubmission().

SeriesEditorSubmissionDAO.deleteDecisionsByMonograph ( $  monographId  ) 

Delete editing decisions by monograph. FIXME: Create EditorDecisionDAO and move this there, see #6455.

Parameters:
$monographId int

Definition at line 257 of file SeriesEditorSubmissionDAO.inc.php.

SeriesEditorSubmissionDAO.deleteReviewRoundsByMonograph ( $  monographId  ) 

Delete review rounds monograph. FIXME: Move to ReviewRoundDAO, see #6455.

Parameters:
$monographId int

Definition at line 269 of file SeriesEditorSubmissionDAO.inc.php.

& SeriesEditorSubmissionDAO.getAllReviewers ( $  pressId  ) 

Retrieve a list of all reviewers in a press FIXME: Move to UserDAO, see #6455.

Parameters:
$pressId int
Returns:
array matching Users

Definition at line 428 of file SeriesEditorSubmissionDAO.inc.php.

Referenced by getReviewerStatistics().

SeriesEditorSubmissionDAO.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 press. FIXME: Move to ReviewAssignmentDAO, see #6455.

Returns:
array

Definition at line 451 of file SeriesEditorSubmissionDAO.inc.php.

& SeriesEditorSubmissionDAO.getById ( $  monographId  ) 

Retrieve a series editor submission by monograph ID.

Parameters:
$monographId int
Returns:
SeriesEditorSubmission

Definition at line 53 of file SeriesEditorSubmissionDAO.inc.php.

References _fromRow().

Referenced by updateSeriesEditorSubmission().

SeriesEditorSubmissionDAO.getEditorDecisions ( $  monographId,
$  stageId = null,
$  round = null 
)

Get the editor decisions for a review round of a monograph. FIXME: Create EditorDecisionDAO and move this there, see #6455.

Parameters:
$monographId int
$stageId int optional
$round int optional

Definition at line 283 of file SeriesEditorSubmissionDAO.inc.php.

Referenced by _fromRow().

SeriesEditorSubmissionDAO.getFilteredReviewers ( $  pressId,
$  doneMin,
$  doneMax,
$  avgMin,
$  avgMax,
$  lastMin,
$  lastMax,
$  activeMin,
$  activeMax,
$  interests,
$  monographId = null,
$  reviewRoundId = null 
)

Given the ranges selected by the editor, produce a filtered list of reviewers FIXME: Move to UserDAO, see #6455.

Parameters:
$pressId int
$doneMin int # of reviews completed int
$doneMax int
$avgMin int Average period of time in days to complete a review int
$avgMax int
$lastMin int Days since most recently completed review int
$lastMax int
$activeMin int How many reviews are currently being considered or underway int
$activeMax int
$interests array
$monographId int Filter out reviewers assigned to this monograph
$reviewRoundId int Also filter users assigned to this round of the given monograph
Returns:
array Users

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

References getReviewersNotAssignedToMonograph(), and getReviewerStatistics().

& SeriesEditorSubmissionDAO.getReviewersForMonograph ( $  pressId,
$  monographId,
$  round 
)

Retrieve a list of all reviewers assigned to a monograph. FIXME: Move to UserDAO, see #6455.

Parameters:
$pressId int
$monographId int
$round int
Returns:
DAOResultFactory containing matching Users

Definition at line 350 of file SeriesEditorSubmissionDAO.inc.php.

& SeriesEditorSubmissionDAO.getReviewersNotAssignedToMonograph ( $  pressId,
$  monographId,
&$  reviewRound,
$  name = '' 
)

Retrieve a list of all reviewers not assigned to the specified monograph. FIXME: Move to UserDAO, see #6455.

Parameters:
$pressId int
$monographId int
$reviewRound ReviewRound
$name string
Returns:
array matching Users

Definition at line 397 of file SeriesEditorSubmissionDAO.inc.php.

Referenced by getFilteredReviewers().

SeriesEditorSubmissionDAO.getReviewerStatistics ( $  pressId  ) 

Get the last assigned and last completed dates for all reviewers of the given press. FIXME: Move to ReviewAssignmentDAO, see #6455.

Parameters:
$pressId int
Returns:
array

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

References getAllReviewers().

Referenced by getFilteredReviewers().

SeriesEditorSubmissionDAO.newDataObject (  ) 

Construct a new data object corresponding to this DAO.

Returns:
SeriesEditorSubmission

Reimplemented from MonographDAO.

Definition at line 91 of file SeriesEditorSubmissionDAO.inc.php.

SeriesEditorSubmissionDAO.reviewerExists ( $  reviewRoundId,
$  reviewerId 
)

Check if a reviewer is assigned to a specified monograph. FIXME: Move to ReviewAssigmentDAO, see #6455.

Parameters:
$reviewRoundId int
$reviewerId int
Returns:
boolean

Definition at line 325 of file SeriesEditorSubmissionDAO.inc.php.

SeriesEditorSubmissionDAO.SeriesEditorSubmissionDAO (  ) 

Constructor.

Definition at line 36 of file SeriesEditorSubmissionDAO.inc.php.

References MonographDAO.MonographDAO().

SeriesEditorSubmissionDAO.transferEditorDecisions ( $  oldUserId,
$  newUserId 
)

Transfer the decisions for an editor.

Parameters:
$oldUserId int
$newUserId int

Definition at line 714 of file SeriesEditorSubmissionDAO.inc.php.

SeriesEditorSubmissionDAO.updateSeriesEditorSubmission ( &$  seriesEditorSubmission  ) 

Update an existing series editorsubmission.

Parameters:
$seriesEditorSubmission SeriesEditorSubmission

Definition at line 145 of file SeriesEditorSubmissionDAO.inc.php.

References _updateEditorDecision(), getById(), and MonographDAO.updateMonograph().

The documentation for this class was generated from the following file:
Generated on Mon Sep 17 2012 13:58:59 for Open Monograph Press by  doxygen 1.7.1