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

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)
 
 getEditorDecisionRoundStatus ()
 
 getInsertId ()
 
 getLastReviewRoundBySubmissionId ($submissionId, $stageId=null)
 
 getReviewRound ($submissionId, $stageId, $round)
 
 insertObject ($reviewRound)
 
 newDataObject ()
 
 ReviewRoundDAO ()
 
 updateObject ($reviewRound)
 
 updateStatus ($reviewRound, $reviewAssignments=array(), $status=null)
 
- 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

Operations for retrieving and modifying ReviewRound objects.

See Also
ReviewRound

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

Member Function Documentation

ReviewRoundDAO::_fromRow (   $row)

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

Parameters
$rowarray
Returns
Signoff

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

References newDataObject().

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

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

Fetch a review round, creating it if needed.

Parameters
$submissionIdinteger
$stageIdinteger One of the WORKFLOW_*_REVIEW_STAGE_ID constants.
$roundinteger
$statusinteger One of the REVIEW_ROUND_STATUS_* constants.
Returns
ReviewRound

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

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

ReviewRoundDAO::deleteById (   $reviewRoundId)

Delete a review round by ID.

Parameters
$reviewRoundIdint
Returns
boolean

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

References DAO\update().

Referenced by deleteObject().

ReviewRoundDAO::deleteBySubmissionId (   $submissionId)

Delete review rounds by submission ID.

Parameters
$submissionIdint

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

References deleteObject(), and getBySubmissionId().

ReviewRoundDAO::deleteObject (   $reviewRound)

Delete a review round.

Parameters
$reviewRoundReviewRound

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

References deleteById().

Referenced by deleteBySubmissionId().

ReviewRoundDAO::getById (   $reviewRoundId)

Retrieve a review round by its id.

Parameters
int$reviewRoundId
Returns
ReviewRound

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

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

ReviewRoundDAO::getBySubmissionFileId (   $submissionFileId)

Retrieve a review round by a submission file id.

Parameters
$submissionFileIdint
Returns
ReviewRound

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

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

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

Get an iterator of review round objects associated with this submission

Parameters
$submissionIdint
$stageIdint (optional)
$roundint (optional)

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

References DAO\retrieve().

Referenced by deleteBySubmissionId().

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

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

Parameters
$submissionIdint
$stageIdint
Returns
int

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

References DAO\retrieve().

ReviewRoundDAO::getEditorDecisionRoundStatus ( )

Return review round status that are related with editor decisions.

Returns
array

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

Referenced by updateStatus().

ReviewRoundDAO::getInsertId ( )

Get the ID of the last inserted review round.

Returns
int

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

References DAO\_getInsertId().

Referenced by build().

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

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

Parameters
$submissionIdint
$stageIdint
Returns
ReviewRound

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

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

Referenced by updateStatus().

ReviewRoundDAO::getReviewRound (   $submissionId,
  $stageId,
  $round 
)

Retrieve a review round

Parameters
$submissionIdinteger
$stageIdint One of the Stage_id_* constants.
$roundint The review round to be retrieved.

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

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

Referenced by build().

ReviewRoundDAO::insertObject (   $reviewRound)

Insert a new review round.

Parameters
$reviewRoundReviewRound
Returns
int

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

References DAO\update().

Referenced by build().

ReviewRoundDAO::newDataObject ( )

Construct a new data object corresponding to this DAO.

Returns
SignoffEntry

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

Referenced by _fromRow(), and build().

ReviewRoundDAO::ReviewRoundDAO ( )

Constructor

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

ReviewRoundDAO::updateObject (   $reviewRound)

Update an existing review round.

Parameters
$reviewRoundReviewRound
Returns
boolean

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

References DAO\update().

ReviewRoundDAO::updateStatus (   $reviewRound,
  $reviewAssignments = array(),
  $status = null 
)

FIXME #7386# Update the review round status. If review assignments is passed and no status, then this method will find the correct review round status based on the review round assignments state.

Parameters
$reviewRoundReviewRound
$reviewAssignmentsarray Review round review assignments.
$statusint

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

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


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