Inheritance diagram for PKP\Services\PKPUserService:

Public Member Functions
	canCurrentUserGossip ($userId)

	canUserAccessStage ($stageId, $workflowType, $userAccessibleStages, $userRoles)

	count ($args=[])

	get ($userId)

	getAccessibleStageRoles ($userId, $contextId, &$submission, $stageId)

	getCount ($args=[])

	getFullProperties ($user, $args=null)

	getIds ($args=[])

	getMany ($args=[])

	getMax ($args=[])

	getProperties ($user, $props, $args=null)

	getQueryBuilder ($args=[])

	getReviewers ($args=[])

	getReviewersMax ($args=[])

	getReviewersQueryBuilder ($args=[])

	getReviewerSummaryProperties ($user, $args=null)

	getRolesOverview ($args=[])

	getSummaryProperties ($user, $args=null)

	userHasRole ($userId, $roleIds, $contextId)

Detailed Description

Definition at line 26 of file PKPUserService.inc.php.

Member Function Documentation

◆ canCurrentUserGossip()

PKP\Services\PKPUserService::canCurrentUserGossip ( $userId )

Can the current user view and edit the gossip field for a user

Parameters

$userId int The user who's gossip field should be accessed

Returns: boolean

Definition at line 469 of file PKPUserService.inc.php.

References PKPApplication\get(), and PKP\Services\PKPUserService\userHasRole().

Referenced by PKP\Services\PKPUserService\getProperties().

◆ canUserAccessStage()

PKP\Services\PKPUserService::canUserAccessStage	(	$stageId,
		$workflowType,
		$userAccessibleStages,
		$userRoles
	)

Can this user access the requested workflow stage

The user must have an assigned role in the specified stage or be a manager or site admin that has no assigned role in the submission.

Parameters

string	$stageId	One of the WORKFLOW_STAGE_ID_* contstants.
string	$workflowType	Accessing the editorial or author workflow? WORKFLOW_TYPE_*
array	$userAccessibleStages	User's assignments to the workflow stages. ASSOC_TYPE_ACCESSIBLE_WORKFLOW_STAGES
array	$userRoles	User's roles in the context

Returns: Boolean

Definition at line 511 of file PKPUserService.inc.php.

References PKPApplication\get().

◆ count()

PKP\Services\PKPUserService::count ( $args = [] )

Get a count of users matching the passed arguments

Parameters

array $args See self::getMany()

Definition at line 567 of file PKPUserService.inc.php.

References PKP\Services\PKPUserService\getQueryBuilder().

Referenced by PKP\Services\PKPUserService\getRolesOverview().

◆ get()

PKP\Services\PKPUserService::get ( $userId )

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

References DAORegistry\getDAO().

◆ getAccessibleStageRoles()

PKP\Services\PKPUserService::getAccessibleStageRoles	(		$userId,
			$contextId,
		&	$submission,
			$stageId
	)

Check for roles that give access to the passed workflow stage.

Parameters

int	$userId
int	$contextId
Submission	$submission
int	$stageId

Returns: array

Definition at line 532 of file PKPUserService.inc.php.

References DAORegistry\getDAO().

◆ getCount()

PKP\Services\PKPUserService::getCount ( $args = [] )

Definition at line 39 of file PKPUserService.inc.php.

References PKP\Services\PKPUserService\getQueryBuilder().

◆ getFullProperties()

PKP\Services\PKPUserService::getFullProperties	(	$user,
		$args = `null`
	)

Definition at line 417 of file PKPUserService.inc.php.

References HookRegistry\call(), and PKP\Services\PKPUserService\getProperties().

◆ getIds()

PKP\Services\PKPUserService::getIds ( $args = [] )

Definition at line 46 of file PKPUserService.inc.php.

References PKP\Services\PKPUserService\getQueryBuilder().

◆ getMany()

PKP\Services\PKPUserService::getMany ( $args = [] )

Get a collection of User objects limited, filtered and sorted by $args

Parameters

array $args @option int contextId If not supplied, CONTEXT_ID_NONE will be used and no submissions will be returned. To retrieve users from all contexts, use CONTEXT_ID_ALL. @option string orderBy @option string orderDirection @option string roleIds @option int assignedToSubmission @option int assignedToSubmissionStage @option array includeUsers @option array excludeUsers @option string status @option string searchPhrase @option int count @option int offset