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

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 ()
 
- Public Member Functions inherited from UserDAO
 newDataObject ()
 
 UserDAO ()
 

Detailed Description

Operations for users as related to their stage assignments.

See Also
User, StageAssignment, and UserDAO

Definition at line 19 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
$submissionIdint
$stageIdint optional
$userGroupIdint optional
$userIdint optional
$roleIdint 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
$submissionIdint
$stageIdint (optional)
$userGroupIdint (optional)
$roleIdint (optional)
$userIdint (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
$submissionIdint
$stageIdint
$userGroupIdint
Returns
object DAOResultFactory

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

UserStageAssignmentDAO::UserStageAssignmentDAO ( )

Constructor

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


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