Inheritance diagram for SubmissionCommentDAO:

Public Member Functions
	_fromRow ($row)

	deleteById ($commentId)

	deleteBySubmissionId ($submissionId)

	deleteObject ($submissionComment)

	getById ($commentId)

	getByUserId ($userId)

	getInsertId ()

	getReviewerCommentsByReviewerId ($submissionId, $reviewerId=null, $reviewId=null, $viewable=null)

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

	insertObject ($submissionComment)

	newDataObject ()

	updateObject ($submissionComment)

Public Member Functions inherited from DAO
	__construct ($dataSource=null, $callHooks=true)

	concat ()

	convertFromDB ($value, $type)

	convertToDB ($value, &$type)

	dateFromDB ($d)

	datetimeFromDB ($dt)

	datetimeToDB ($dt)

	dateToDB ($d)

	flushCache ()

	formatDateToDB ($date, $defaultNumWeeks=null, $acceptPastDate=true)

	getAdditionalFieldNames ()

	getAffectedRows ()

	getDataObjectSettings ($tableName, $idFieldName, $idFieldValue, $dataObject)

	getDataSource ()

	getDirectionMapping ($direction)

	getDriver ()

	getLocaleFieldNames ()

	getType ($value)

	handleError ($dataSource, $sql)

	nullOrInt ($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, $content='')

Data Fields 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

◆ _fromRow()

SubmissionCommentDAO::_fromRow ( $row )

Creates and returns a submission comment object from a row

Parameters

$row array

Returns: SubmissionComment object

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

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

Referenced by getById().

◆ deleteById()

SubmissionCommentDAO::deleteById ( $commentId )

Removes a submission note by id

Parameters

noteId int

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

References DAO\update().

Referenced by deleteObject().

◆ deleteBySubmissionId()

SubmissionCommentDAO::deleteBySubmissionId ( $submissionId )

Delete all comments for a submission.

Parameters

$submissionId int

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

References DAO\update().

◆ deleteObject()

SubmissionCommentDAO::deleteObject ( $submissionComment )

Removes a submission comment from the submission_comments table

Parameters

SubmissionComment object

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

References deleteById().

◆ getById()

SubmissionCommentDAO::getById ( $commentId )

Retrieve submission comment by id

Parameters

$commentId int Comment ID.

Returns: SubmissionComment object

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

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

◆ getByUserId()

SubmissionCommentDAO::getByUserId ( $userId )

Retrieve SubmissionComments by user id

Parameters

$userId int User ID.

Returns: DAOResultFactory

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

References DAO\retrieve().

◆ getInsertId()

SubmissionCommentDAO::getInsertId ( )

Get the ID of the last inserted submission comment.

Returns: int

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

References DAO\_getInsertId().

Referenced by insertObject().

◆ getReviewerCommentsByReviewerId()

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

Retrieve SubmissionComments made my reviewers on a submission

Parameters

$submissionId	int The submission Id that was reviewered/commented on.
$reviewerId	int The user id of the reviewer.
$reviewId	int (optional) The review assignment ID the comment pertains to.
$viewable	boolean True for only viewable comments; false for non-viewable; null for both