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

Public Member Functions

 _fromRow ($row)
 
 deleteById ($commentId)
 
 deleteBySubmissionId ($submissionId)
 
 deleteObject ($submissionComment)
 
 getById ($commentId)
 
 getByUserId ($userId)
 
 getInsertId ()
 
 getMostRecentSubmissionComment ($submissionId, $commentType=null, $assocId=null)
 
 getReviewerCommentsByReviewerId ($reviewerId, $submissionId, $reviewId=null)
 
 getSubmissionComments ($submissionId, $commentType=null, $assocId=null)
 
 insertObject ($submissionComment)
 
 newDataObject ()
 
 SubmissionCommentDAO ()
 
 updateObject ($submissionComment)
 
- 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 SubmissionComment objects.

See Also
SubmissionComment

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

Member Function Documentation

SubmissionCommentDAO::_fromRow (   $row)

Creates and returns a submission comment object from a row

Parameters
$rowarray
Returns
SubmissionComment object

Definition at line 156 of file SubmissionCommentDAO.inc.php.

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

Referenced by getById(), and getMostRecentSubmissionComment().

SubmissionCommentDAO::deleteById (   $commentId)

Removes a submission note by id

Parameters
noteIdint

Definition at line 223 of file SubmissionCommentDAO.inc.php.

References DAO\update().

Referenced by deleteObject().

SubmissionCommentDAO::deleteBySubmissionId (   $submissionId)

Delete all comments for a submission.

Parameters
$submissionIdint

Definition at line 234 of file SubmissionCommentDAO.inc.php.

References DAO\update().

SubmissionCommentDAO::deleteObject (   $submissionComment)

Removes a submission comment from the submission_comments table

Parameters
SubmissionCommentobject

Definition at line 215 of file SubmissionCommentDAO.inc.php.

References deleteById().

SubmissionCommentDAO::getById (   $commentId)

Retrieve submission comment by id

Parameters
$commentIdint
Returns
SubmissionComment object

Definition at line 132 of file SubmissionCommentDAO.inc.php.

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

SubmissionCommentDAO::getByUserId (   $userId)

Retrieve SubmissionComments by user id

Parameters
$userIdint
Returns
DAOResultFactory

Definition at line 61 of file SubmissionCommentDAO.inc.php.

References DAO\retrieve().

SubmissionCommentDAO::getInsertId ( )

Get the ID of the last inserted submission comment.

Returns
int

Definition at line 207 of file SubmissionCommentDAO.inc.php.

References DAO\_getInsertId().

Referenced by insertObject().

SubmissionCommentDAO::getMostRecentSubmissionComment (   $submissionId,
  $commentType = null,
  $assocId = null 
)

Retrieve most recent SubmissionComment

Parameters
$submissionIdint
$commentTypeint
Returns
SubmissionComment

Definition at line 95 of file SubmissionCommentDAO.inc.php.

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

SubmissionCommentDAO::getReviewerCommentsByReviewerId (   $reviewerId,
  $submissionId,
  $reviewId = null 
)

Retrieve SubmissionComments made my reviewers on a submission

Parameters
$reviewerIdint The user id of the reviewer.
$submissionIdint The submission Id that was reviewered/commented on.
$reviewIdint (optional) The review assignment ID the comment pertains to.
Returns
DAOResultFactory

Definition at line 76 of file SubmissionCommentDAO.inc.php.

References DAO\retrieve().

SubmissionCommentDAO::getSubmissionComments (   $submissionId,
  $commentType = null,
  $assocId = null 
)

Retrieve SubmissionComments by submission id

Parameters
$submissionIdint
$commentTypeint
$assocIdint
Returns
DAOResultFactory

Definition at line 34 of file SubmissionCommentDAO.inc.php.

References DAO\retrieve().

SubmissionCommentDAO::insertObject (   $submissionComment)

inserts a new submission comment into the submission_comments table

Parameters
SubmissionNoteobject
Returns
Submission note ID int

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

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

SubmissionCommentDAO::newDataObject ( )

Construct a new DataObject.

Returns
DataObject

Definition at line 147 of file SubmissionCommentDAO.inc.php.

Referenced by _fromRow().

SubmissionCommentDAO::SubmissionCommentDAO ( )

Constructor

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

SubmissionCommentDAO::updateObject (   $submissionComment)

Updates a submission comment

Parameters
SubmissionCommentobject

Definition at line 245 of file SubmissionCommentDAO.inc.php.

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


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