UserGridHandler Class Reference

Handle user grid requests. More...

List of all members.

Public Member Functions
	addUser ($args, &$request)
	authorize (&$request, $args, $roleAssignments)
	disableUser ($args, &$request)
	editDisableUser ($args, &$request)
	editEmail ($args, &$request)
	editUser ($args, &$request)
	getFilterForm ()
	getFilterSelectionData (&$request)
&	getRowInstance ()
	initialize (&$request)
	loadData (&$request, $filter)
	removeUser ($args, &$request)
	renderFilter (&$request)
	sendEmail ($args, &$request)
	suggestUsername ($args, &$request)
	updateUser ($args, &$request)
	updateUserRoles ($args, &$request)
	UserGridHandler ()

---

Detailed Description

Handle user grid requests.

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

---

Member Function Documentation

UserGridHandler.addUser	(	$	args,
		&$	request
	)

Add a new user.

Parameters:

	$args	array
	$request	PKPRequest

Definition at line 277 of file UserGridHandler.inc.php.

References editUser().

UserGridHandler.authorize	(	&$	request,
		$	args,
		$	roleAssignments
	)

See also:

PKPHandler.authorize()

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

UserGridHandler.disableUser	(	$	args,
		&$	request
	)

Enable/Disable an existing user

Parameters:

	$args	array
	$request	PKPRequest

Returns:

string Serialized JSON object

Definition at line 423 of file UserGridHandler.inc.php.

References Validation.canAdminister().

UserGridHandler.editDisableUser	(	$	args,
		&$	request
	)

Edit enable/disable user form

Parameters:

	$args	array
	$request	PKPRequest

Returns:

string Serialized JSON object

Definition at line 392 of file UserGridHandler.inc.php.

References Validation.canAdminister().

UserGridHandler.editEmail	(	$	args,
		&$	request
	)

Displays a modal to edit an email message to the user.

Parameters:

	$args	array
	$request	PKPRequest

Returns:

string Serialized JSON object

Definition at line 493 of file UserGridHandler.inc.php.

References Validation.canAdminister().

UserGridHandler.editUser	(	$	args,
		&$	request
	)

Edit an existing user.

Parameters:

	$args	array
	$request	PKPRequest

Returns:

string Serialized JSON object

Definition at line 288 of file UserGridHandler.inc.php.

References Validation.canAdminister().

Referenced by addUser().

UserGridHandler.getFilterForm

(

)

See also:

GridHandler.getFilterForm()

Returns:

string Filter template.

Definition at line 248 of file UserGridHandler.inc.php.

UserGridHandler.getFilterSelectionData

(

&$

request

)

See also:

GridHandler.getFilterSelectionData()

Returns:

array Filter selection data.

Definition at line 227 of file UserGridHandler.inc.php.

& UserGridHandler.getRowInstance

(

)

See also:

GridHandler.getRowInstance()

Returns:

UserGridRow

Definition at line 129 of file UserGridHandler.inc.php.

UserGridHandler.initialize

(

&$

request

)

See also:

PKPHandler.initialize()

Definition at line 51 of file UserGridHandler.inc.php.

UserGridHandler.loadData	(	&$	request,
		$	filter
	)

See also:

GridHandler.loadData()

Parameters:

$request

PKPRequest

Returns:

array Grid data.

Definition at line 139 of file UserGridHandler.inc.php.

UserGridHandler.removeUser	(	$	args,
		&$	request
	)

Remove all user group assignments for a press for a given user.

Parameters:

	$args	array
	$request	PKPRequest

Returns:

string Serialized JSON object

Definition at line 462 of file UserGridHandler.inc.php.

References Validation.canAdminister().

UserGridHandler.renderFilter

(

&$

request

)

See also:

GridHandler.renderFilter()

Definition at line 189 of file UserGridHandler.inc.php.

UserGridHandler.sendEmail	(	$	args,
		&$	request
	)

Send the user email and close the modal.

Parameters:

	$args	array
	$request	PKPRequest

Returns:

string Serialized JSON object

Definition at line 519 of file UserGridHandler.inc.php.

References Validation.canAdminister().

UserGridHandler.suggestUsername	(	$	args,
		&$	request
	)

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

Parameters:

	$args	array
	$request	PKPRequest

Definition at line 262 of file UserGridHandler.inc.php.

UserGridHandler.updateUser	(	$	args,
		&$	request
	)

Update an existing user.

Parameters:

	$args	array
	$request	PKPRequest

Returns:

string Serialized JSON object

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

References Validation.canAdminister().

UserGridHandler.updateUserRoles	(	$	args,
		&$	request
	)

Update a newly created user's roles

Parameters:

	$args	array
	$request	PKPRequest

Returns:

string Serialized JSON object

Definition at line 359 of file UserGridHandler.inc.php.

References Validation.canAdminister().

UserGridHandler.UserGridHandler

(

)

Constructor

Definition at line 25 of file UserGridHandler.inc.php.

---

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

• controllers/grid/settings/user/UserGridHandler.inc.php