GroupHandler Class Reference
[Pages_manager]

Handle requests for editorial team management functions. More...

Inheritance diagram for GroupHandler:

List of all members.

Public Member Functions
	addMembership ($args)
	createGroup ($args)
	deleteGroup ($args)
	deleteMembership ($args)
	editGroup ($args=array())
	groupMembership ($args)
	groups ()
	moveGroup ()
	moveMembership ()
	updateGroup ()
	validate ($groupId=null, $userId=null, $fetchMembership=false)

---

Detailed Description

Handle requests for editorial team management functions.

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

---

Member Function Documentation

GroupHandler.addMembership

(

$

args

)

Add group membership (or list users if none chosen).

Reimplemented from ManagerHandler.

Definition at line 168 of file GroupHandler.inc.php.

References DAORegistry.getDAO(), TemplateManager.getManager(), Request.getUserVar(), Request.redirect(), String.strtoupper(), Locale.translate(), and ManagerHandler.validate().

GroupHandler.createGroup

(

$

args

)

Display form to create new group.

Reimplemented from ManagerHandler.

Definition at line 107 of file GroupHandler.inc.php.

References editGroup().

GroupHandler.deleteGroup

(

$

args

)

Delete a group.

Parameters:

$args

array first parameter is the ID of the group to delete

Reimplemented from ManagerHandler.

Definition at line 42 of file GroupHandler.inc.php.

References DAORegistry.getDAO(), Request.redirect(), and ManagerHandler.validate().

GroupHandler.deleteMembership

(

$

args

)

Delete group membership.

Reimplemented from ManagerHandler.

Definition at line 237 of file GroupHandler.inc.php.

References DAORegistry.getDAO(), Request.redirect(), and ManagerHandler.validate().

GroupHandler.editGroup

(

$

args = array()

)

Display form to edit a group.

Parameters:

$args

array optional, first parameter is the ID of the group to edit

Reimplemented from ManagerHandler.

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

References DAORegistry.getDAO(), TemplateManager.getManager(), Request.redirect(), and ManagerHandler.validate().

Referenced by createGroup().

GroupHandler.groupMembership

(

$

args

)

View group membership.

Reimplemented from ManagerHandler.

Definition at line 150 of file GroupHandler.inc.php.

References DAORegistry.getDAO(), TemplateManager.getManager(), Handler.getRangeInfo(), and ManagerHandler.validate().

GroupHandler.groups

(

)

Display a list of groups for the current journal.

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

References DAORegistry.getDAO(), TemplateManager.getManager(), Handler.getRangeInfo(), and ManagerHandler.validate().

GroupHandler.moveGroup

(

)

Change the sequence of a group.

Definition at line 56 of file GroupHandler.inc.php.

References DAORegistry.getDAO(), Request.getUserVar(), Request.redirect(), and ManagerHandler.validate().

GroupHandler.moveMembership

(

)

Change the sequence of a group membership.

Definition at line 253 of file GroupHandler.inc.php.

References DAORegistry.getDAO(), Request.getUserVar(), Request.redirect(), and ManagerHandler.validate().

GroupHandler.updateGroup

(

)

Save changes to a group.

Definition at line 114 of file GroupHandler.inc.php.

References TemplateManager.getManager(), Request.getUserVar(), Request.redirect(), Request.url(), and ManagerHandler.validate().

GroupHandler.validate	(	$	groupId = null,
		$	userId = null,
		$	fetchMembership = false
	)

Validate the request. If a group ID is supplied, the group object will be fetched and validated against the current journal. If, additionally, the user ID is supplied, the user and membership objects will be validated and fetched.

Parameters:

	$groupId	int optional
	$userId	int optional
	$fetchMembership	boolean Whether or not to fetch membership object as last element of return array, redirecting if it doesn't exist; default false

Returns:

array [$journal] iff $groupId is null, [$journal, $group] iff $userId is null and $groupId is supplied, and [$journal, $group, $user] iff $userId and $groupId are both supplied. $fetchMembership===true will append membership info to the last case, redirecting if it doesn't exist.

Definition at line 297 of file GroupHandler.inc.php.

References DAORegistry.getDAO(), Request.getJournal(), and Request.redirect().

---

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

• pages/manager/GroupHandler.inc.php