Open Journal Systems  3.3.0
UserStageAssignmentDAO Class Reference
Inheritance diagram for UserStageAssignmentDAO:
UserDAO DAO

Public Member Functions

 _getUsersByIds ($submissionId, $stageId=null, $userGroupId=null, $userId=null, $roleId=null)
 
 deleteAssignment ($assignmentId)
 
 filterUsersNotAssignedToStageInUserGroup ($submissionId, $stageId, $userGroupId, $name=null, $rangeInfo=null)
 
 getUsersBySubmissionAndStageId ($submissionId, $stageId=null, $userGroupId=null, $roleId=null, $userId=null)
 
 getUsersNotAssignedToStageInUserGroup ($submissionId, $stageId, $userGroupId)
 
- Public Member Functions inherited from UserDAO
 _returnUserFromRow ($row, $callHook=true)
 
 _returnUserFromRowWithData ($row, $callHook=true)
 
 _returnUserFromRowWithReviewerStats ($row)
 
 changeSitePrimaryLocale ($oldLocale, $newLocale)
 
 deleteObject ($user)
 
 deleteUserById ($userId)
 
 getAdditionalFieldNames ()
 
 getById ($userId, $allowDisabled=true)
 
 getBySetting ($settingName, $settingValue, $allowDisabled=true)
 
 getByUsername ($username, $allowDisabled=true)
 
 getFetchColumns ()
 
 getFetchJoins ()
 
 getFetchParameters ()
 
 getInsertId ()
 
 getLocaleFieldNames ()
 
 getOrderBy ()
 
 getReviewersForSubmission ($contextId, $submissionId, $round)
 
 getReviewersNotAssignedToSubmission ($contextId, $submissionId, &$reviewRound, $name='')
 
 getUserByAuthStr ($authstr, $allowDisabled=true)
 
 getUserByCredentials ($username, $password, $allowDisabled=true)
 
 getUserByEmail ($email, $allowDisabled=true)
 
 getUserEmail ($userId, $allowDisabled=true)
 
 getUserFullName ($userId, $allowDisabled=true)
 
 getUsersWithNoRole ($allowDisabled=true, $dbResultRange=null)
 
 insertObject ($user)
 
 newDataObject ()
 
 updateLocaleFields ($user)
 
 updateObject ($user)
 
 userExistsByEmail ($email, $userId=null, $allowDisabled=true)
 
 userExistsById ($userId, $allowDisabled=true)
 
 userExistsByUsername ($username, $userId=null, $allowDisabled=true)
 
- 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)
 
 getAffectedRows ()
 
 getDataObjectSettings ($tableName, $idFieldName, $idFieldValue, $dataObject)
 
 getDataSource ()
 
 getDirectionMapping ($direction)
 
 getDriver ()
 
 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 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

◆ _getUsersByIds()

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 122 of file UserStageAssignmentDAO.inc.php.

References UserDAO\_returnUserFromRowWithData(), and DAO\retrieve().

Referenced by getUsersBySubmissionAndStageId().

◆ deleteAssignment()

UserStageAssignmentDAO::deleteAssignment (   $assignmentId)

Delete a stage assignment by Id.

Parameters
$assignmentId
Returns
bool

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

References DAO\update().

◆ filterUsersNotAssignedToStageInUserGroup()

UserStageAssignmentDAO::filterUsersNotAssignedToStageInUserGroup (   $submissionId,
  $stageId,
  $userGroupId,
  $name = null,
  $rangeInfo = null 
)

Retrieve a set of users of a user group not assigned to a given submission stage and matching the specified settings.

Parameters
$submissionIdint
$stageIdint
$userGroupIdint
$namestring|null Partial string match with user name
$rangeInfo|nullobject The desired range of results to return
Returns
object DAOResultFactory

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

References PKPApplication\get(), AppLocale\getLocale(), and DAO\retrieveRange().

◆ getUsersBySubmissionAndStageId()

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 50 of file UserStageAssignmentDAO.inc.php.

References _getUsersByIds().

◆ getUsersNotAssignedToStageInUserGroup()

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 27 of file UserStageAssignmentDAO.inc.php.

References DAO\retrieve().


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