Public Member Functions

UserStageAssignmentDAO Class Reference

Operations for users as related to their stage assignments. More...

Inheritance diagram for UserStageAssignmentDAO:
UserDAO

List of all members.

Public Member Functions

 _getUsersByIds ($submissionId, $stageId=null, $userGroupId=null, $userId=null, $roleId=null)
 deleteAssignment ($assignmentId)
 getUsersBySubmissionAndStageId ($submissionId, $stageId=null, $userGroupId=null, $roleId=null, $userId=null)
 getUsersNotAssignedToStageInUserGroup ($submissionId, $stageId, $userGroupId)
 UserStageAssignmentDAO ()

Detailed Description

Operations for users as related to their stage assignments.

See also:
User, StageAssignment, and UserDAO

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

Member Function Documentation

UserStageAssignmentDAO._getUsersByIds ( $  submissionId,
$  stageId = null,
$  userGroupId = null,
$  userId = null,
$  roleId = null 
)

Retrieve a user by submission and stage IDs. Private method because it 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
Returns:
object DAOResultFactory

Definition at line 85 of file UserStageAssignmentDAO.inc.php.

Referenced by getUsersBySubmissionAndStageId().

UserStageAssignmentDAO.deleteAssignment ( $  assignmentId  ) 

Delete a stage assignment by Id.

Parameters:
$assignmentId 
Returns:
bool

Definition at line 66 of file UserStageAssignmentDAO.inc.php.

UserStageAssignmentDAO.getUsersBySubmissionAndStageId ( $  submissionId,
$  stageId = null,
$  userGroupId = null,
$  roleId = null,
$  userId = null 
)

Retrieve StageAssignments by submission and stage IDs.

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

Definition at line 57 of file UserStageAssignmentDAO.inc.php.

References _getUsersByIds().

UserStageAssignmentDAO.getUsersNotAssignedToStageInUserGroup ( $  submissionId,
$  stageId,
$  userGroupId 
)

Retrieve a set of users not assigned to a given submission stage as a user group

Parameters:
$submissionId int
$stageId int
$userGroupId int
Returns:
object DAOResultFactory

Definition at line 33 of file UserStageAssignmentDAO.inc.php.

UserStageAssignmentDAO.UserStageAssignmentDAO (  ) 

Constructor

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

References UserDAO.UserDAO().

The documentation for this class was generated from the following file:
Generated on Mon Sep 17 2012 13:58:59 for Open Monograph Press by  doxygen 1.7.1