Inheritance diagram for PKP\Services\PKPEmailTemplateService:

Public Member Functions
	add ($emailTemplate, $request)

	delete ($emailTemplate)

	edit ($emailTemplate, $params, $request)

	get ($emailTemplateId)

	getByKey ($contextId, $key)

	getCount ($args=[])

	getFullProperties ($emailTemplate, $args=null)

	getIds ($args=[])

	getMany ($args=[])

	getMax ($args=[])

	getProperties ($emailTemplate, $props, $args=null)

	getQueryBuilder ($args=[])

	getSummaryProperties ($emailTemplate, $args=null)

	restoreDefaults ($contextId)

	validate ($action, $props, $allowedLocales, $primaryLocale)

Detailed Description

Definition at line 32 of file PKPEmailTemplateService.inc.php.

Member Function Documentation

◆ add()

PKP\Services\PKPEmailTemplateService::add	(	$emailTemplate,
		$request
	)

Definition at line 268 of file PKPEmailTemplateService.inc.php.

References HookRegistry\call(), PKP\Services\PKPEmailTemplateService\getByKey(), and DAORegistry\getDAO().

Referenced by PKP\Services\PKPEmailTemplateService\validate().

◆ delete()

PKP\Services\PKPEmailTemplateService::delete ( $emailTemplate )

Definition at line 320 of file PKPEmailTemplateService.inc.php.

References HookRegistry\call(), and DAORegistry\getDAO().

◆ edit()

PKP\Services\PKPEmailTemplateService::edit	(	$emailTemplate,
		$params,
		$request
	)

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

References HookRegistry\call(), PKP\Services\PKPEmailTemplateService\getByKey(), and DAORegistry\getDAO().

◆ get()

PKP\Services\PKPEmailTemplateService::get ( $emailTemplateId )

Do not use. An email template should be retrieved by its key.

See also: PKPEmailTemplateService::getByKey()

Definition at line 39 of file PKPEmailTemplateService.inc.php.

◆ getByKey()

PKP\Services\PKPEmailTemplateService::getByKey	(	$contextId,
		$key
	)

Get an email template by key

Returns a custom email template if one exists for the requested context or the default template if no custom template exists.

Returns null if no template is found for the requested key

Parameters

integer	$contextId
string	$key

Returns: EmailTemplate

Definition at line 55 of file PKPEmailTemplateService.inc.php.

References DAORegistry\getDAO().

Referenced by PKP\Services\PKPEmailTemplateService\add(), PKP\Services\PKPEmailTemplateService\edit(), and PKP\Services\PKPEmailTemplateService\validate().

◆ getCount()

PKP\Services\PKPEmailTemplateService::getCount ( $args = [] )

Definition at line 73 of file PKPEmailTemplateService.inc.php.

References PKP\Services\PKPEmailTemplateService\getQueryBuilder().

Referenced by PKP\Services\PKPEmailTemplateService\getMax().

◆ getFullProperties()

PKP\Services\PKPEmailTemplateService::getFullProperties	(	$emailTemplate,
		$args = `null`
	)

Definition at line 199 of file PKPEmailTemplateService.inc.php.

References PKPServices\get(), PKP\Services\PKPEmailTemplateService\getProperties(), and PKP\Services\SCHEMA_EMAIL_TEMPLATE.

◆ getIds()

PKP\Services\PKPEmailTemplateService::getIds ( $args = [] )

Definition at line 80 of file PKPEmailTemplateService.inc.php.

◆ getMany()

PKP\Services\PKPEmailTemplateService::getMany ( $args = [] )

Get email templates

Parameters

array $args { @option bool isEnabled @option int|array fromRoleIds @option int|array toRoleIds @option string searchPhrase @option int|array stageIds }