Inheritance diagram for StageAssignmentDAO:

Public Member Functions
	_fromRow ($row)

	_getByIds ($submissionId=null, $stageId=null, $userGroupId=null, $userId=null, $roleId=null, $single=false)

	build ($submissionId, $userGroupId, $userId, $recommendOnly=false, $canChangeMetadata=null)

	deleteByAll ($submissionId, $userGroupId, $userId)

	deleteObject ($stageAssignment)

	editorAssignedToStage ($submissionId, $stageId=null)

	getBaseQueryForAssignmentSelection ()

	getById ($stageAssignmentId)

	getBySubmissionAndRoleId ($submissionId, $roleId, $stageId=null, $userId=null)

	getBySubmissionAndStageId ($submissionId, $stageId=null, $userGroupId=null, $userId=null)

	getBySubmissionAndUserIdAndStageId ($submissionId, $userId, $stageId=null)

	getByUserGroupId ($userGroupId, $contextId)

	getByUserId ($userId)

	getEditorsAssignedToStage ($submissionId, $stageId)

	getInsertId ()

	insertObject ($stageAssignment)

	newDataObject ()

	updateObject ($stageAssignment)

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 StageAssignment objects.

See also: StageAssignment

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

Member Function Documentation

◆ _fromRow()

StageAssignmentDAO::_fromRow ( $row )

Internal function to return an StageAssignment object from a row.

Parameters

$row array

Returns: StageAssignment

Definition at line 190 of file StageAssignmentDAO.inc.php.

References newDataObject().

Referenced by _getByIds(), and getById().

◆ _getByIds()

StageAssignmentDAO::_getByIds	(	$submissionId = `null`,
		$stageId = `null`,
		$userGroupId = `null`,
		$userId = `null`,
		$roleId = `null`,
		$single = `false`
	)

Retrieve a stageAssignment by submission and stage IDs. Private method that holds most of the work. serves two purposes: returns a single assignment or returns a factory, depending on the calling context.

Parameters

$submissionId	int
$stageId	int optional
$userGroupId	int optional
$userId	int optional
$roleId	int optional ROLE_ID_...
$single	bool specify if only one stage assignment (default is a ResultFactory)

Returns: StageAssignment|ResultFactory Mixed, depending on $single

Definition at line 305 of file StageAssignmentDAO.inc.php.

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

Referenced by getBySubmissionAndRoleId(), getBySubmissionAndStageId(), getBySubmissionAndUserIdAndStageId(), and getByUserId().

◆ build()

StageAssignmentDAO::build	(	$submissionId,
		$userGroupId,
		$userId,
		$recommendOnly = `false`,
		$canChangeMetadata = `null`
	)

Fetch a stageAssignment by symbolic info, building it if needed.

Parameters

$submissionId	int
$userGroupId	int
$userId	int
$recommendOnly	boolean
$canChangeMetadata	boolean

Returns: StageAssignment

Definition at line 150 of file StageAssignmentDAO.inc.php.

References getBySubmissionAndStageId(), DAORegistry\getDAO(), getInsertId(), insertObject(), and newDataObject().

◆ deleteByAll()

StageAssignmentDAO::deleteByAll	(	$submissionId,
		$userGroupId,
		$userId
	)

Delete a stageAssignment by matching on all fields.

Parameters

$submissionId	int Submission ID
$userGroupId	int User group ID
$userId	int User ID

Definition at line 274 of file StageAssignmentDAO.inc.php.

References DAO\update().

Referenced by deleteObject().

◆ deleteObject()

StageAssignmentDAO::deleteObject ( $stageAssignment )

Delete a StageAssignment.

Parameters

$stageAssignment StageAssignment

Definition at line 260 of file StageAssignmentDAO.inc.php.

References deleteByAll().

◆ editorAssignedToStage()

StageAssignmentDAO::editorAssignedToStage	(	$submissionId,
		$stageId = `null`
	)

Test if an editor or a sub editor is assigned to the submission This test is used to determine what grid to place a submission into, and to know if the review stage can be started.

Parameters