Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
GroupHandler Class Reference
Inheritance diagram for GroupHandler:
ManagerHandler Handler PKPHandler

Public Member Functions

 addMembership ($args)
 
 createGroup ($args)
 
 deleteGroup ($args)
 
 deleteMembership ($args)
 
 editGroup ($args=array())
 
 GroupHandler ()
 
 groupMembership ($args)
 
 groups ()
 
 moveGroup ()
 
 moveMembership ($args)
 
 updateGroup ()
 
 validate ($groupId=null, $userId=null, $fetchMembership=false)
 
- Public Member Functions inherited from ManagerHandler
 email ($args)
 
 index ()
 
 ManagerHandler ()
 
retrieveRoleAssignmentPreferences ($journalId)
 
 setupTemplate ($subclass=false)
 
- Public Member Functions inherited from PKPHandler
 addCheck (&$handlerValidator)
 
 addPolicy (&$authorizationPolicy, $addToTop=false)
 
 addRoleAssignment ($roleIds, $operations)
 
 authorize (&$request, &$args, $roleAssignments)
 
getAuthorizedContext ()
 
getAuthorizedContextObject ($assocType)
 
getDispatcher ()
 
 getId ()
 
 getLastAuthorizationMessage ()
 
 getLoginExemptions ()
 
getRangeInfo ($rangeName, $contextData=null)
 
 getRoleAssignment ($roleId)
 
 getRoleAssignments ()
 
 hashPageContext ($contextData=array())
 
 index ()
 
 initialize (&$request, $args=null)
 
 PKPHandler ()
 
 requireSSL ()
 
 setDispatcher (&$dispatcher)
 
 setId ($id)
 
 validate ($requiredContexts=null, $request=null)
 

Public Attributes

 $group
 
 $groupMembership
 
 $user
 

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).

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

References $group, $groupMembership, $user, DAORegistry\getDAO(), Request\getJournal(), PKPRequest\getUserVar(), PKPRequest\redirect(), String\strtoupper(), and validate().

GroupHandler::createGroup (   $args)

Display form to create new group.

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

References editGroup().

GroupHandler::deleteGroup (   $args)

Delete a group.

Parameters
$argsarray first parameter is the ID of the group to delete

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

References $group, DAORegistry\getDAO(), PKPRequest\redirect(), and validate().

GroupHandler::deleteMembership (   $args)

Delete group membership.

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

References $group, $groupMembership, $user, DAORegistry\getDAO(), PKPRequest\redirect(), and validate().

GroupHandler::editGroup (   $args = array())

Display form to edit a group.

Parameters
$argsarray optional, first parameter is the ID of the group to edit

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

References $group, DAORegistry\getDAO(), Request\getJournal(), PKPRequest\redirect(), and validate().

Referenced by createGroup().

GroupHandler::GroupHandler ( )

Constructor

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

GroupHandler::groupMembership (   $args)

View group membership.

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

References $group, DAORegistry\getDAO(), PKPHandler\getRangeInfo(), and validate().

Referenced by validate().

GroupHandler::groups ( )

Display a list of groups for the current journal.

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

References DAORegistry\getDAO(), Request\getJournal(), PKPHandler\getRangeInfo(), and validate().

GroupHandler::moveGroup ( )

Change the sequence of a group.

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

References $group, DAORegistry\getDAO(), Request\getJournal(), PKPRequest\getUserVar(), PKPRequest\redirect(), and validate().

GroupHandler::moveMembership (   $args)

Change the sequence of a group membership.

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

References $group, $groupMembership, DAORegistry\getDAO(), PKPRequest\getUserVar(), PKPRequest\redirect(), and validate().

GroupHandler::updateGroup ( )

Save changes to a group.

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

References $group, PKPRequest\getUserVar(), PKPRequest\redirect(), 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 journal. If, additionally, the user ID is supplied, the user and membership objects will be validated and fetched.

Parameters
$groupIdint optional
$userIdint optional
$fetchMembershipboolean 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 379 of file GroupHandler.inc.php.

References $group, $groupMembership, $user, DAORegistry\getDAO(), Request\getJournal(), groupMembership(), and PKPRequest\redirect().

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

Member Data Documentation

GroupHandler::$group

group associated with the request

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

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

GroupHandler::$groupMembership

groupMembership associated with the request

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

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

GroupHandler::$user

user associated with the request

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

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


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