GroupHandler Class Reference
[Pages_manager]

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

Inheritance diagram for GroupHandler:

ManagerHandler Handler List of all members.

Public Member Functions

 addMembership ($args)
 createGroup ($args)
 deleteGroup ($args)
 deleteMembership ($args)
 editGroup ($args=array())
 GroupHandler ()
 groupMembership ($args)
 groups ()
 moveGroup ()
 moveMembership ($args)
 setBoardEnabled ($args)
 setupTemplate ($group=null, $subclass=false)
 updateGroup ()
 validate ($groupId=null, $userId=null, $fetchMembership=false)

Public Attributes

 $group
 $groupMembership
 $user

Detailed Description

Handle requests for organizing team management functions.

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


Member Function Documentation

GroupHandler.addMembership ( args  ) 

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

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

References $group, $groupMembership, $user, Request.getConference(), Request.getSchedConf(), groupMembership(), groups(), Request.redirect(), setupTemplate(), and validate().

GroupHandler.createGroup ( args  ) 

Display form to create new group.

Definition at line 160 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

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

References $group, Request.getSchedConf(), groups(), Request.redirect(), and validate().

GroupHandler.deleteMembership ( args  ) 

Delete group membership.

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

References $group, $groupMembership, $user, Request.getSchedConf(), groupMembership(), Request.redirect(), and 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

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

References $group, Request.getSchedConf(), groups(), Request.redirect(), setupTemplate(), and validate().

Referenced by createGroup(), and setupTemplate().

GroupHandler.GroupHandler (  ) 

Constructor

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

GroupHandler.groupMembership ( args  ) 

View group membership.

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

References $group, groups(), setupTemplate(), and validate().

Referenced by addMembership(), deleteMembership(), moveMembership(), and validate().

GroupHandler.groups (  ) 

Display a list of groups for the current conference.

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

References Request.getSchedConf(), setupTemplate(), and validate().

Referenced by addMembership(), deleteGroup(), editGroup(), groupMembership(), moveGroup(), setBoardEnabled(), setupTemplate(), updateGroup(), and validate().

GroupHandler.moveGroup (  ) 

Change the sequence of a group.

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

References $group, Request.getSchedConf(), groups(), Request.redirect(), and validate().

GroupHandler.moveMembership ( args  ) 

Change the sequence of a group membership.

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

References $group, $groupMembership, groupMembership(), Request.redirect(), and validate().

GroupHandler.updateGroup (  ) 

Save changes to a group.

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

References $group, groups(), Request.redirect(), setupTemplate(), Request.url(), and 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 conference. 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 [$conference] iff $groupId is null, [$conference, $group] iff $userId is null and $groupId is supplied, and [$conference, $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 400 of file GroupHandler.inc.php.

References $group, $groupMembership, $user, Request.getConference(), Request.getSchedConf(), groupMembership(), groups(), and Request.redirect().

Referenced by addMembership(), deleteGroup(), deleteMembership(), editGroup(), groupMembership(), groups(), moveGroup(), moveMembership(), setBoardEnabled(), and updateGroup().


Member Data Documentation

GroupHandler.$group

group associated with the request

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

Referenced by addMembership(), deleteGroup(), deleteMembership(), editGroup(), groupMembership(), moveGroup(), moveMembership(), setupTemplate(), updateGroup(), and validate().

GroupHandler.$groupMembership

group membership associated with the request

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

Referenced by addMembership(), deleteMembership(), moveMembership(), and validate().

GroupHandler.$user

user associated with the request

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

Referenced by addMembership(), deleteMembership(), and validate().


The documentation for this class was generated from the following file:
Generated on 25 Jul 2013 for Open Conference Systems by  doxygen 1.4.7