PeopleHandler Class Reference
[Pages_manager]

Handle requests for people management functions. More...

Inheritance diagram for PeopleHandler:

List of all members.

Public Member Functions
	createUser ()
	disableUser ($args)
	editUser ($args=array())
	enableUser ($args)
	enroll ($args)
	enrollSearch ($args)
	enrollSync ($args)
	enrollSyncSelect ($args)
	mergeUsers ($args)
	people ($args)
	removeUser ($args)
	signInAsUser ($args)
	signOutAsUser ()
	suggestUsername ()
	unEnroll ($args)
	updateUser ()
	userProfile ($args)

---

Detailed Description

Handle requests for people management functions.

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

---

Member Function Documentation

PeopleHandler.createUser

(

)

Display form to create a new user.

Reimplemented from ManagerHandler.

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

References editUser().

PeopleHandler.disableUser

(

$

args

)

Disable a user's account.

Parameters:

$args

array the ID of the user to disable

Reimplemented from ManagerHandler.

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

References Validation.canAdminister(), DAORegistry.getDAO(), Request.getJournal(), TemplateManager.getManager(), Request.getUser(), Request.getUserVar(), Request.redirect(), and Request.url().

PeopleHandler.editUser

(

$

args = array()

)

Display form to create/edit a user profile.

Parameters:

$args

array optional, if set the first parameter is the ID of the user to edit

Reimplemented from ManagerHandler.

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

References Validation.canAdminister(), Request.getJournal(), TemplateManager.getManager(), and Request.url().

Referenced by createUser().

PeopleHandler.enableUser

(

$

args

)

Enable a user's account.

Parameters:

$args

array the ID of the user to enable

Reimplemented from ManagerHandler.

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

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

PeopleHandler.enroll

(

$

args

)

Enroll a user in a role.

Reimplemented from ManagerHandler.

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

References DAORegistry.getDAO(), Request.getRequestedJournalPath(), Request.getUserVar(), and Request.redirect().

PeopleHandler.enrollSearch

(

$

args

)

Search for users to enroll in a specific role.

Parameters:

$args

array first parameter is the selected role ID

Reimplemented from ManagerHandler.

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

References DAORegistry.getDAO(), TemplateManager.getManager(), Handler.getRangeInfo(), Request.getRequestedJournalPath(), Request.getUser(), Request.getUserVar(), String.strtoupper(), and Locale.translate().

PeopleHandler.enrollSync

(

$

args

)

Synchronize user enrollment with another journal.

Reimplemented from ManagerHandler.

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

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

PeopleHandler.enrollSyncSelect

(

$

args

)

Show form to synchronize user enrollment with another journal.

Reimplemented from ManagerHandler.

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

References DAORegistry.getDAO(), Request.getJournal(), and TemplateManager.getManager().

PeopleHandler.mergeUsers

(

$

args

)

Allow the Journal Manager to merge user accounts, including attributed articles etc.

Reimplemented from ManagerHandler.

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

References Validation.canAdminister(), DAORegistry.getDAO(), Request.getJournal(), TemplateManager.getManager(), Handler.getRangeInfo(), Request.getUser(), Request.getUserVar(), Request.redirect(), String.regexp_match_get(), String.strtoupper(), Locale.translate(), and Request.url().

PeopleHandler.people

(

$

args

)

Display list of people in the selected role.

Parameters:

$args

array first parameter is the role ID to display

Reimplemented from ManagerHandler.

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

References DAORegistry.getDAO(), Request.getJournal(), TemplateManager.getManager(), Handler.getRangeInfo(), Request.getUser(), Request.getUserVar(), Request.redirect(), String.regexp_match_get(), String.strtoupper(), Locale.translate(), and Request.url().

PeopleHandler.removeUser

(

$

args

)

Remove a user from all roles for the current journal.

Parameters:

$args

array the ID of the user to remove

Reimplemented from ManagerHandler.

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

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

PeopleHandler.signInAsUser

(

$

args

)

Sign in as another user.

Parameters:

$args

array ($userId)

Reimplemented from ManagerHandler.

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

References Validation.canAdminister(), DAORegistry.getDAO(), Request.getJournal(), TemplateManager.getManager(), Request.getRequestedPage(), Request.getSession(), Request.redirect(), and Request.url().

PeopleHandler.signOutAsUser

(

)

Restore original user account after signing in as a user.

Reimplemented from ManagerHandler.

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

References DAORegistry.getDAO(), Request.getRequestedPage(), Request.getSession(), Request.redirect(), and Handler.validate().

PeopleHandler.suggestUsername

(

)

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

Reimplemented from ManagerHandler.

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

References Request.getUserVar(), and Validation.suggestUsername().

PeopleHandler.unEnroll

(

$

args

)

Unenroll a user from a role.

Reimplemented from ManagerHandler.

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

References DAORegistry.getDAO(), Request.getRequestedJournalPath(), Request.getUserVar(), and Request.redirect().

PeopleHandler.updateUser

(

)

Save changes to a user profile.

Reimplemented from ManagerHandler.

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

References Validation.canAdminister(), Request.getJournal(), TemplateManager.getManager(), Request.getUserVar(), Request.redirect(), Request.redirectUrl(), Request.url(), and ManagerHandler.validate().

PeopleHandler.userProfile

(

$

args

)

Display a user's profile.

Parameters:

$args

array first parameter is the ID or username of the user to display

Reimplemented from ManagerHandler.

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

References Locale.getAllLocales(), DAORegistry.getDAO(), Request.getJournal(), TemplateManager.getManager(), Request.getSite(), and Request.url().

---

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

• pages/manager/PeopleHandler.inc.php