PKPEmailTemplateHandler Class Reference

Inheritance diagram for PKPEmailTemplateHandler:

Public Member Functions
	__construct ()
	add ($slimRequest, $response, $args)
	authorize ($request, &$args, $roleAssignments)
	delete ($slimRequest, $response, $args)
	edit ($slimRequest, $response, $args)
	get ($slimRequest, $response, $args)
	getMany ($slimRequest, $response, $args)
	restoreDefaults ($slimRequest, $response, $args)
Public Member Functions inherited from APIHandler
	convertStringsToSchema ($schema, $params)
	getApp ()
	getEndpointPattern ()
	getEndpoints ()
	getEntityId ($parameterName)
	getParameter ($parameterName, $default=null)
	getRequest ()
	getSlimRequest ()
	setSlimRequest ($slimRequest)
	setupEndpoints ()
Public Member Functions inherited from PKPHandler
	addPolicy ($authorizationPolicy, $addToTop=false)
	addRoleAssignment ($roleIds, $operations)
	getApiToken ()
&	getAuthorizedContext ()
&	getAuthorizedContextObject ($assocType)
&	getDispatcher ()
	getFirstUserContext ($user, $contexts)
	getId ()
	getLastAuthorizationMessage ()
	getRoleAssignment ($roleId)
	getRoleAssignments ()
	getSiteRedirectContext ($request)
	getTargetContext ($request, &$contextsCount=null)
	index ($args, $request)
	initialize ($request)
	markRoleAssignmentsChecked ()
	requireSSL ()
	setApiToken ($apiToken)
	setDispatcher ($dispatcher)
	setEnforceRestrictedSite ($enforceRestrictedSite)
	setId ($id)
	setupTemplate ($request)
	validate ($requiredContexts=null, $request=null)

Additional Inherited Members
Static Public Member Functions inherited from PKPHandler
static	getPageParamName ($rangeName)
static	getRangeInfo ($request, $rangeName, $contextData=null)
static	hashPageContext ($request, $contextData=array())
Data Fields inherited from PKPHandler
	$_authorizationDecisionManager
	$_checks = array()
	$_dispatcher
	$_enforceRestrictedSite = true
	$_id
	$_isBackendPage = false
	$_roleAssignments = array()
	$_roleAssignmentsChecked = false
Protected Member Functions inherited from APIHandler
	_validateStatDates ($params, $dateStartParam='dateStart', $dateEndParam='dateEnd')
Protected Attributes inherited from APIHandler
	$_app
	$_endpoints = array()
	$_handlerPath = null
	$_pathPattern
	$_request
	$_slimRequest = null
Protected Attributes inherited from PKPHandler
	$_apiToken = null

Detailed Description

Base class to handle API requests for contexts (journals/presses).

Definition at line 17 of file PKPEmailTemplateHandler.inc.php.

Constructor & Destructor Documentation

__construct()

PKPEmailTemplateHandler::__construct

(

)

Constructor

Reimplemented from APIHandler.

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

References APIHandler\getEndpointPattern().

Member Function Documentation

add()

PKPEmailTemplateHandler::add	(		$slimRequest,
			$response,
			$args
	)

Add an email template

Parameters

	$slimRequest	Request Slim request object
	$response	Response object
array	$args	arguments

Returns

Response

Definition at line 183 of file PKPEmailTemplateHandler.inc.php.

References APIHandler\convertStringsToSchema(), PKPServices\get(), Application\getContextDAO(), and APIHandler\getRequest().

authorize()

PKPEmailTemplateHandler::authorize	(		$request,
		&	$args,
			$roleAssignments
	)

Authorize this request.

Routers will call this method automatically thereby enforcing authorization. This method will be called before the validate() method and before passing control on to the handler operation.

NB: This method will be called once for every request only.

Parameters

$request	Request
$args	array request arguments
$roleAssignments	array the operation role assignment, see getRoleAssignment() for more details.

Returns

boolean

Reimplemented from PKPHandler.

Definition at line 70 of file PKPEmailTemplateHandler.inc.php.

References PKPHandler\addPolicy().

delete()

PKPEmailTemplateHandler::delete	(		$slimRequest,
			$response,
			$args
	)

Delete an email template

Parameters

	$slimRequest	Request Slim request object
	$response	Response object
array	$args	arguments

Returns

Response

Definition at line 278 of file PKPEmailTemplateHandler.inc.php.

References PKPServices\get(), and APIHandler\getRequest().

edit()

PKPEmailTemplateHandler::edit	(		$slimRequest,
			$response,
			$args
	)

Edit an email template

Parameters

	$slimRequest	Request Slim request object
	$response	Response object
array	$args	arguments

Returns

Response

Definition at line 223 of file PKPEmailTemplateHandler.inc.php.

References APIHandler\convertStringsToSchema(), PKPServices\get(), PKPHandler\getAuthorizedContextObject(), and APIHandler\getRequest().

get()

PKPEmailTemplateHandler::get	(		$slimRequest,
			$response,
			$args
	)

Get a single email template

Parameters

	$slimRequest	Request Slim request object
	$response	Response object
array	$args	arguments

Returns

Response

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

References PKPServices\get(), and APIHandler\getRequest().

getMany()

PKPEmailTemplateHandler::getMany	(		$slimRequest,
			$response,
			$args
	)

Get a collection of email templates

Parameters

$slimRequest	Request Slim request object
$response	Response object
$args	array arguments

Returns

Response

Definition at line 95 of file PKPEmailTemplateHandler.inc.php.

References HookRegistry\call(), PKPServices\get(), and APIHandler\getRequest().

restoreDefaults()

PKPEmailTemplateHandler::restoreDefaults	(		$slimRequest,
			$response,
			$args
	)

Restore defaults in the email template settings

Parameters

	$slimRequest	Request Slim request object
	$response	Response object
array	$args	arguments

Returns

Response

Definition at line 309 of file PKPEmailTemplateHandler.inc.php.

References PKPServices\get(), and APIHandler\getRequest().

---

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

• PKPEmailTemplateHandler.inc.php