PreparedEmailsGridHandler Class Reference

Handle preparedEmails grid requests. More...

List of all members.

Public Member Functions
	addPreparedEmail ($args, &$request)
	authorize (&$request, $args, $roleAssignments)
	deleteCustomEmail ($args, &$request)
	disableEmail ($args, &$request)
	editPreparedEmail ($args, &$request)
	enableEmail ($args, &$request)
&	getRowInstance ()
	PreparedEmailsGridHandler ()
	resetAllEmails ($args, &$request)
	resetEmail ($args, &$request)
	updatePreparedEmail ($args, &$request)

---

Detailed Description

Handle preparedEmails grid requests.

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

---

Member Function Documentation

PreparedEmailsGridHandler.addPreparedEmail	(	$	args,
		&$	request
	)

Create a new prepared email

Parameters:

	$args	array
	$request	PKPRequest

Returns:

string Serialized JSON object

Definition at line 127 of file PreparedEmailsGridHandler.inc.php.

References editPreparedEmail().

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

See also:

PKPHandler.authorize()

Parameters:

	$request	PKPRequest
	$args	array
	$roleAssignments	array

Definition at line 40 of file PreparedEmailsGridHandler.inc.php.

PreparedEmailsGridHandler.deleteCustomEmail	(	$	args,
		&$	request
	)

Delete a custom email.

Parameters:

	$args	array
	$request	Request

Definition at line 289 of file PreparedEmailsGridHandler.inc.php.

PreparedEmailsGridHandler.disableEmail	(	$	args,
		&$	request
	)

Disables an email template.

Parameters:

	$args	array
	$request	Request

Definition at line 219 of file PreparedEmailsGridHandler.inc.php.

PreparedEmailsGridHandler.editPreparedEmail	(	$	args,
		&$	request
	)

Edit a prepared email Will create a new prepared email if their is no emailKey in the request

Parameters:

	$args	array
	$request	PKPRequest

Returns:

string Serialized JSON object

Definition at line 138 of file PreparedEmailsGridHandler.inc.php.

Referenced by addPreparedEmail().

PreparedEmailsGridHandler.enableEmail	(	$	args,
		&$	request
	)

Enables an email template.

Parameters:

	$args	array
	$request	Request

Definition at line 257 of file PreparedEmailsGridHandler.inc.php.

& PreparedEmailsGridHandler.getRowInstance

(

)

Get the row handler - override the default row handler

Returns:

PreparedEmailsGridRow

Definition at line 112 of file PreparedEmailsGridHandler.inc.php.

PreparedEmailsGridHandler.PreparedEmailsGridHandler

(

)

Constructor

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

PreparedEmailsGridHandler.resetAllEmails	(	$	args,
		&$	request
	)

Reset all email to stock.

Parameters:

	$args	array
	$request	Request

Definition at line 207 of file PreparedEmailsGridHandler.inc.php.

PreparedEmailsGridHandler.resetEmail	(	$	args,
		&$	request
	)

Reset a single email

Parameters:

	$args	array
	$request	Request

Returns:

string a serialized JSON object

Definition at line 186 of file PreparedEmailsGridHandler.inc.php.

PreparedEmailsGridHandler.updatePreparedEmail	(	$	args,
		&$	request
	)

Save the email editing form

Parameters:

	$args	array
	$request	PKPRequest

Returns:

string Serialized JSON object

Definition at line 156 of file PreparedEmailsGridHandler.inc.php.

---

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

• controllers/grid/settings/preparedEmails/PreparedEmailsGridHandler.inc.php