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

Public Member Functions

 createUser ($args, &$request)
 
 disableUser ($args)
 
 editUser ($args, &$request)
 
 enableUser ($args)
 
 enroll ($args)
 
 enrollSearch ($args)
 
 enrollSync ($args)
 
 enrollSyncSelect ($args)
 
 mergeUsers ($args)
 
 people ($args)
 
 PeopleHandler ()
 
 removeUser ($args)
 
 showNoRole ()
 
 suggestUsername ()
 
 unEnroll ($args)
 
 updateUser ($args, &$request)
 
 userProfile ($args)
 
- 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 ()
 
 setDispatcher (&$dispatcher)
 
 setId ($id)
 
 validate ($requiredContexts=null, $request=null)
 

Detailed Description

Handle requests for people management functions.

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

Member Function Documentation

PeopleHandler::createUser (   $args,
$request 
)

Display form to create a new user.

Parameters
$argsarray
$requestPKPRequest

Definition at line 369 of file PeopleHandler.inc.php.

References editUser().

PeopleHandler::disableUser (   $args)
PeopleHandler::editUser (   $args,
$request 
)

Display form to create/edit a user profile.

Parameters
$argsarray optional, if set the first parameter is the ID of the user to edit

Definition at line 390 of file PeopleHandler.inc.php.

References Validation\canAdminister(), Request\getJournal(), ManagerHandler\retrieveRoleAssignmentPreferences(), ManagerHandler\setupTemplate(), Request\url(), and PKPHandler\validate().

Referenced by createUser().

PeopleHandler::enableUser (   $args)

Enable a user's account.

Parameters
$argsarray the ID of the user to enable

Definition at line 587 of file PeopleHandler.inc.php.

References DAORegistry\getDAO(), PKPRequest\getUser(), PKPRequest\redirect(), ManagerHandler\setupTemplate(), and PKPHandler\validate().

PeopleHandler::enroll (   $args)
PeopleHandler::enrollSearch (   $args)
PeopleHandler::enrollSync (   $args)

Synchronize user enrollment with another journal.

Definition at line 340 of file PeopleHandler.inc.php.

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

PeopleHandler::enrollSyncSelect (   $args)

Show form to synchronize user enrollment with another journal.

Definition at line 310 of file PeopleHandler.inc.php.

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

PeopleHandler::PeopleHandler ( )

Constructor

Definition at line 22 of file PeopleHandler.inc.php.

PeopleHandler::removeUser (   $args)

Remove a user from all roles for the current journal.

Parameters
$argsarray the ID of the user to remove

Definition at line 610 of file PeopleHandler.inc.php.

References DAORegistry\getDAO(), Request\getJournal(), PKPRequest\getUser(), PKPRequest\redirect(), ManagerHandler\setupTemplate(), and PKPHandler\validate().

PeopleHandler::showNoRole ( )

Show users with no role.

Definition at line 232 of file PeopleHandler.inc.php.

References DAORegistry\getDAO(), PKPHandler\getRangeInfo(), PKPRequest\getUser(), and PKPHandler\validate().

PeopleHandler::suggestUsername ( )

Get a suggested username, making sure it's not already used by the system. (Poor-man's AJAX.)

Definition at line 377 of file PeopleHandler.inc.php.

References PKPRequest\getUserVar(), Validation\suggestUsername(), and PKPHandler\validate().

PeopleHandler::unEnroll (   $args)
PeopleHandler::updateUser (   $args,
$request 
)

Save changes to a user profile.

Definition at line 629 of file PeopleHandler.inc.php.

References Validation\canAdminister(), ManagerHandler\setupTemplate(), Request\url(), and PKPHandler\validate().

PeopleHandler::userProfile (   $args)

Display a user's profile.

Parameters
$argsarray first parameter is the ID or username of the user to display

Definition at line 686 of file PeopleHandler.inc.php.

References PKPLocale\getAllLocales(), DAORegistry\getDAO(), Request\getJournal(), PKPRequest\getSite(), Validation\isSiteAdmin(), ManagerHandler\setupTemplate(), Request\url(), and PKPHandler\validate().


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