Operations for retrieving and modifying User Groups and user group assignments FIXME: Some of the context-specific features of this class will have to be changed for zero- or double-context applications when user groups are ported over to them. More...

Public Member Functions
	assignGroupToStage ($pressId, $userGroupId, $stageId)
	assignGroupToStage ($pressId, $userGroupId, $stageId)
	getAssignedStagesByUserGroupId ($pressId, $userGroupId)
	getAssignedStagesByUserGroupId ($pressId, $userGroupId)
	getIdFromPath ($stagePath)
	getIdFromPath ($stagePath)
	getPathFromId ($stageId)
	getPathFromId ($stageId)
	getTranslationKeyFromId ($stageId)
	getTranslationKeyFromId ($stageId)
&	getUserGroupsByStage ($pressId, $stageId, $omitAuthors=false, $omitReviewers=false, $roleId=null)
&	getUserGroupsByStage ($pressId, $stageId, $omitAuthors=false, $omitReviewers=false, $roleId=null)
	getWorkflowStageKeysAndPaths ()
	getWorkflowStageKeysAndPaths ()
	getWorkflowStageTranslationKeys ()
	getWorkflowStageTranslationKeys ()
	removeGroupFromStage ($pressId, $userGroupId, $stageId)
	removeGroupFromStage ($pressId, $userGroupId, $stageId)
	userAssignmentExists ($pressId, $userId, $stageId)
	userAssignmentExists ($pressId, $userId, $stageId)
	userGroupAssignedToStage ($userGroupId, $stageId)
	userGroupAssignedToStage ($userGroupId, $stageId)
	UserGroupDAO ()
	UserGroupDAO ()

Detailed Description

Operations for retrieving and modifying User Groups and user group assignments FIXME: Some of the context-specific features of this class will have to be changed for zero- or double-context applications when user groups are ported over to them.

See also:: PKPUserGroupDAO

Definition at line 21 of file UserGroupDAO.inc.php.

Member Function Documentation

UserGroupDAO.assignGroupToStage	(	$	pressId,
		$	userGroupId,
		$	stageId
	)

Assign a user group to a stage

Parameters:

	$pressId	int
	$userGroupId	int
	$stageId	int

Returns:: bool

Definition at line 113 of file UserGroupDAO.inc.php.

UserGroupDAO.assignGroupToStage	(	$	pressId,
		$	userGroupId,
		$	stageId
	)

Assign a user group to a stage

Parameters:

	$pressId	int
	$userGroupId	int
	$stageId	int

Returns:: bool

Definition at line 113 of file UserGroupDAO.inc.php.

UserGroupDAO.getAssignedStagesByUserGroupId	(	$	pressId,
		$	userGroupId
	)

Get all stages assigned to one user group in one context.

Parameters:

	Integer	$pressId The user group context.
	Integer	$userGroupId

Definition at line 63 of file UserGroupDAO.inc.php.

References getTranslationKeyFromId().

UserGroupDAO.getAssignedStagesByUserGroupId	(	$	pressId,
		$	userGroupId
	)

Get all stages assigned to one user group in one context.

Parameters:

	Integer	$pressId The user group context.
	Integer	$userGroupId

Definition at line 63 of file UserGroupDAO.inc.php.

References getTranslationKeyFromId().

UserGroupDAO.getIdFromPath ( $ stagePath )

Convert a stage path into a stage id

Parameters:

$stagePath

string

Returns:: integer|null

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

UserGroupDAO.getIdFromPath ( $ stagePath )

Convert a stage path into a stage id

Parameters:

$stagePath

string

Returns:: integer|null

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

UserGroupDAO.getPathFromId ( $ stageId )

Convert a stage id into a stage path

Parameters:

$stageId

integer

Returns:: string|null

Definition at line 170 of file UserGroupDAO.inc.php.

Referenced by getWorkflowStageKeysAndPaths().

UserGroupDAO.getPathFromId ( $ stageId )

Convert a stage id into a stage path

Parameters:

$stageId

integer

Returns:: string|null

Definition at line 170 of file UserGroupDAO.inc.php.

UserGroupDAO.getTranslationKeyFromId ( $ stageId )

Convert a stage id into a stage translation key

Parameters:

$stageId

integer

Returns:: string|null

Definition at line 210 of file UserGroupDAO.inc.php.

References getWorkflowStageTranslationKeys().

Referenced by getAssignedStagesByUserGroupId().

UserGroupDAO.getTranslationKeyFromId ( $ stageId )

Convert a stage id into a stage translation key

Parameters:

$stageId

integer

Returns:: string|null

Definition at line 210 of file UserGroupDAO.inc.php.

References getWorkflowStageTranslationKeys().

& UserGroupDAO.getUserGroupsByStage	(	$	pressId,
		$	stageId,
		$	omitAuthors = `false`,
		$	omitReviewers = `false`,
		$	roleId = `null`
	)

Get the user groups assigned to each stage. Provide the ability to omit authors and reviewers Since these are typically stored differently and displayed in different circumstances

Parameters:

	$pressId
	$stageId

Returns:: DAOResultFactory

Definition at line 36 of file UserGroupDAO.inc.php.

& UserGroupDAO.getUserGroupsByStage	(	$	pressId,
		$	stageId,
		$	omitAuthors = `false`,
		$	omitReviewers = `false`,
		$	roleId = `null`
	)

Get the user groups assigned to each stage. Provide the ability to omit authors and reviewers Since these are typically stored differently and displayed in different circumstances

Parameters:

	$pressId
	$stageId

Returns:: DAOResultFactory

Definition at line 36 of file UserGroupDAO.inc.php.

UserGroupDAO.getWorkflowStageKeysAndPaths ( )

Return a mapping of workflow stages, its translation keys and paths.

Returns:: array

Definition at line 239 of file UserGroupDAO.inc.php.

References getPathFromId(), and getWorkflowStageTranslationKeys().

UserGroupDAO.getWorkflowStageKeysAndPaths ( )

Return a mapping of workflow stages, its translation keys and paths.

Returns:: array

Definition at line 239 of file UserGroupDAO.inc.php.

References getPathFromId(), and getWorkflowStageTranslationKeys().

UserGroupDAO.getWorkflowStageTranslationKeys ( )

Return a mapping of workflow stages and its translation keys. NB: PHP4 work-around for a private static class member

Returns:: array

Definition at line 222 of file UserGroupDAO.inc.php.

UserGroupDAO.getWorkflowStageTranslationKeys ( )

Return a mapping of workflow stages and its translation keys. NB: PHP4 work-around for a private static class member

Returns:: array

Definition at line 222 of file UserGroupDAO.inc.php.

Referenced by getTranslationKeyFromId(), and getWorkflowStageKeysAndPaths().

UserGroupDAO.removeGroupFromStage	(	$	pressId,
		$	userGroupId,
		$	stageId
	)

Remove a user group from a stage

Parameters:

	$pressId	int
	$userGroupId	int
	$stageId	int

Returns:: bool

Definition at line 127 of file UserGroupDAO.inc.php.

UserGroupDAO.removeGroupFromStage	(	$	pressId,
		$	userGroupId,
		$	stageId
	)

Remove a user group from a stage

Parameters:

	$pressId	int
	$userGroupId	int
	$stageId	int

Returns:: bool

Definition at line 127 of file UserGroupDAO.inc.php.

UserGroupDAO.userAssignmentExists	(	$	pressId,
		$	userId,
		$	stageId
	)

Check to see whether a user is assigned to a stage ID via a user group.

Parameters:

	$pressId	int
	$userId	int
	$staeId	int

Returns:: boolean

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

UserGroupDAO.userAssignmentExists	(	$	pressId,
		$	userId,
		$	stageId
	)

Check to see whether a user is assigned to a stage ID via a user group.

Parameters:

	$pressId	int
	$userId	int
	$staeId	int

Returns:: boolean

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

UserGroupDAO.userGroupAssignedToStage	(	$	userGroupId,
		$	stageId
	)

Check if a user group is assigned to a stage

Parameters:

	int	$userGroupId
	int	$stageId

Returns:: bool

Definition at line 89 of file UserGroupDAO.inc.php.

UserGroupDAO.userGroupAssignedToStage	(	$	userGroupId,
		$	stageId
	)

Check if a user group is assigned to a stage

Parameters:

	int	$userGroupId
	int	$stageId

Returns:: bool

Definition at line 89 of file UserGroupDAO.inc.php.

UserGroupDAO.UserGroupDAO ( )

Constructor.

Definition at line 25 of file UserGroupDAO.inc.php.

UserGroupDAO.UserGroupDAO ( )

Constructor.

Definition at line 25 of file UserGroupDAO.inc.php.

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

classes/security/UserGroupDAO.inc.php
omp.JipGdx/omp-1.0b/classes/security/UserGroupDAO.inc.php

UserGroupDAO Class Reference

Public Member Functions

Detailed Description

Member Function Documentation