Public Member Functions

StageAssignmentDAO Class Reference
[StageAssignment]

Operations for retrieving and modifying StageAssignment objects. More...

List of all members.

Public Member Functions

 _fromRow (&$row)
 _getByIds ($submissionId=null, $stageId=null, $userGroupId=null, $userId=null, $roleId=null, $single=false)
 build ($submissionId, $userGroupId, $userId)
 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)
 getByUserId ($userId)
 getEditorsAssignedToStage ($submissionId, $stageId)
 getInsertStageAssignmentId ()
 insertObject (&$stageAssignment)
 newDataObject ()
 StageAssignmentDAO ()

Detailed Description

Operations for retrieving and modifying StageAssignment objects.

See also:
StageAssignment

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


Member Function Documentation

StageAssignmentDAO._fromRow ( &$  row  ) 

Internal function to return an StageAssignment object from a row.

Parameters:
$row array
Returns:
StageAssignment

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

References newDataObject().

Referenced by _getByIds(), and getById().

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
$single bool specify if only one stage assignment (default is a ResultFactory)
Returns:
StageAssignment or ResultFactory

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

References _fromRow(), and getBaseQueryForAssignmentSelection().

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

StageAssignmentDAO.build ( submissionId,
userGroupId,
userId 
)

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

Parameters:
$submissionId int
$userGroupId int
$userId int
Returns:
StageAssignment

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

References getBySubmissionAndStageId(), getInsertStageAssignmentId(), insertObject(), and newDataObject().

StageAssignmentDAO.deleteByAll ( submissionId,
userGroupId,
userId 
)

Delete a stageAssignment by matching on all fields.

Parameters:
$submissionId int
$userGroupId int
$userId int
Returns:
boolean

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

Referenced by deleteObject().

StageAssignmentDAO.deleteObject ( stageAssignment  ) 

Delete a StageAssignment.

Parameters:
$stageAssignment StageAssignment
Returns:
int

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

References deleteByAll().

StageAssignmentDAO.editorAssignedToStage ( submissionId,
stageId = null 
)

Test if an editor or a series 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:
$submissionId (int) The id of the submission being tested.
$stageId (int) The id of the stage being tested.
Returns:
bool

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

StageAssignmentDAO.getBaseQueryForAssignmentSelection (  ) 

Base query to select an stage assignment.

Returns:
string

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

Referenced by _getByIds(), and getById().

StageAssignmentDAO.getById ( stageAssignmentId  ) 

Retrieve an assignment by its ID

Parameters:
$stageAssignmentId int
Returns:
StageAssignment

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

References _fromRow(), and getBaseQueryForAssignmentSelection().

StageAssignmentDAO.getBySubmissionAndRoleId ( submissionId,
roleId,
stageId = null,
userId = null 
)

Retrieve StageAssignments by submission and role IDs.

Parameters:
$submissionId int
$roleId int
$stageId int (optional)
$userId int (optional)
Returns:
DAOResultFactory StageAssignment

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

References _getByIds().

Referenced by getEditorsAssignedToStage().

StageAssignmentDAO.getBySubmissionAndStageId ( submissionId,
stageId = null,
userGroupId = null,
userId = null 
)

Retrieve StageAssignments by submission and stage IDs.

Parameters:
$submissionId int
$stageId int (optional)
$userGroupId int (optional)
$userId int (optional)
Returns:
DAOResultFactory StageAssignment

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

References _getByIds().

Referenced by build().

StageAssignmentDAO.getByUserId ( userId  ) 
Parameters:
$userId int
Returns:
StageAssignment

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

References _getByIds().

StageAssignmentDAO.getEditorsAssignedToStage ( submissionId,
stageId 
)

Get editor stage assignments.

Parameters:
$submissionId int
$stageId int
Returns:
array

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

References getBySubmissionAndRoleId().

StageAssignmentDAO.getInsertStageAssignmentId (  ) 

Get the ID of the last inserted stage assignment.

Returns:
int

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

Referenced by build().

StageAssignmentDAO.insertObject ( &$  stageAssignment  ) 

Insert a new StageAssignment.

Parameters:
$stageAssignment StageAssignment
Returns:
bool

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

Referenced by build().

StageAssignmentDAO.newDataObject (  ) 

Construct a new data object corresponding to this DAO.

Returns:
StageAssignmentEntry

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

Referenced by _fromRow(), and build().

StageAssignmentDAO.StageAssignmentDAO (  ) 

Constructor

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


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