SubmissionMailTemplate Class Reference

Inheritance diagram for SubmissionMailTemplate:

Public Member Functions
	__construct ($submission, $emailKey=null, $locale=null, $context=null, $includeSignature=true)
	assignParams ($paramArray=array())
	bccAssignedSubEditors ($submissionId, $stageId)
	ccAssignedSubEditors ($submissionId, $stageId)
	log ($request=null)
	send ($request=null)
	sendWithParams ($paramArray)
	setContext ($context)
	setEventType ($eventType)
	toAssignedSubEditors ($submissionId, $stageId)
Public Member Functions inherited from MailTemplate
	__construct ($emailKey=null, $locale=null, $context=null, $includeSignature=true)
	clearRecipients ($clearHeaders=true)
	getAddressFieldsEnabled ()
	hasErrors ()
	isEnabled ()
	manageURLValues ($targetString, $key, $value)
	replaceParams ()
	send ()
	setAddressFieldsEnabled ($addressFieldsEnabled)
Public Member Functions inherited from Mail
	__construct ()
	addAttachment ($filePath, $fileName='', $contentType='', $contentDisposition='attachment')
	addBcc ($email, $name='')
	addCc ($email, $name='')
	addHeader ($name, $content)
	addPrivateParam ($name, $value)
	addRecipient ($email, $name='')
	addReplyTo ($email, $name='')
	clearAllRecipients ()
	getAddressArrayString ($addresses, $includeNames=true, $send=false)
&	getAttachments ()
	getBccs ()
	getBccString ()
	getBody ()
	getCcs ()
	getCcString ()
	getContentType ()
	getEnvelopeSender ()
	getFrom ()
	getFromString ($send=false)
	getHeaders ()
	getRecipients ()
	getRecipientString ()
	getReplyTo ()
	getReplyToString ($send=false)
	getSubject ()
	hasAttachments ()
	promoteCcsIfNoRecipients ()
	setBccs ($bccs)
	setBody ($body)
	setCcs ($ccs)
	setContentType ($contentType)
	setEnvelopeSender ($envelopeSender)
	setFrom ($email, $name='')
	setHeaders (&$headers)
	setPrivateParams ($privateParams)
	setRecipients ($recipients)
	setReplyTo ($email, $name='')
	setSubject ($subject)
Public Member Functions inherited from DataObject
	addSupportedMetadataAdapter ($metadataAdapter)
	extractMetadata ($metadataSchema)
	getAdditionalMetadataFieldNames ()
&	getAllData ()
	getDAO ()
&	getData ($key, $locale=null)
	getHasLoadableAdapters ()
	getId ()
	getLocaleMetadataFieldNames ()
	getLocalizedData ($key, $preferredLocale=null)
	getMetadataFieldNames ($translated=true)
	getSetMetadataFieldNames ($translated=true)
	getSupportedExtractionAdapters ()
	getSupportedInjectionAdapters ()
	getSupportedMetadataSchemas ()
	hasData ($key, $locale=null)
	injectMetadata ($metadataDescription)
	removeSupportedMetadataAdapter ($metadataSchemaName)
	setAllData (&$data)
	setData ($key, $value, $locale=null)
	setHasLoadableAdapters ($hasLoadableAdapters)
	setId ($id)
	unsetData ($key, $locale=null)
	upcastTo ($targetObject)

Data Fields
	$context
	$logEventType
	$submission
Data Fields inherited from MailTemplate
	$addressFieldsEnabled
	$bccSender
	$context
	$emailKey
	$enabled
	$errorMessages
	$includeSignature
	$locale
	$params
Data Fields inherited from Mail
	$privateParams
Data Fields inherited from DataObject
	$_data = array()
	$_extractionAdaptersLoaded = false
	$_hasLoadableAdapters = false
	$_injectionAdaptersLoaded = false
	$_metadataExtractionAdapters = array()
	$_metadataInjectionAdapters = array()

Protected Member Functions
	_addUsers ($submissionId, $roleId, $stageId, $method)

Additional Inherited Members
Static Public Member Functions inherited from Mail
static	encodeDisplayName ($displayName, $send=false)

Detailed Description

Subclass of MailTemplate for sending emails related to submissions.

This allows for submission-specific functionality like logging, etc.

Definition at line 20 of file SubmissionMailTemplate.inc.php.

Constructor & Destructor Documentation

__construct()

SubmissionMailTemplate::__construct	(		$submission,
			$emailKey = null,
			$locale = null,
			$context = null,
			$includeSignature = true
	)

Constructor.

Parameters

$submission	Submission
$emailKey	string optional
$locale	string optional
$context	object optional
$includeSignature	boolean optional

See also

MailTemplate::MailTemplate()

Definition at line 49 of file SubmissionMailTemplate.inc.php.

References $context, MailTemplate\$emailKey, MailTemplate\$includeSignature, MailTemplate\$locale, and $submission.

Member Function Documentation

_addUsers()

SubmissionMailTemplate::_addUsers (   $submissionId,   $roleId,   $stageId,   $method  )

protected

Fetch the requested users and add to the email

Parameters

$submissionId	int
$roleId	int
$stageId	int
$method	string one of addRecipient, addCC, or addBCC

Returns

array of Users

Definition at line 188 of file SubmissionMailTemplate.inc.php.

References DAORegistry\getDAO().

Referenced by bccAssignedSubEditors(), ccAssignedSubEditors(), and toAssignedSubEditors().

assignParams()

SubmissionMailTemplate::assignParams

(

$paramArray = array()

)

Assign parameters to template

Parameters

$paramArray

array

Reimplemented from MailTemplate.

Reimplemented in ArticleMailTemplate.

Definition at line 58 of file SubmissionMailTemplate.inc.php.

References $submission, PKPApplication\get(), and PKPString\stripUnsafeHtml().

Referenced by sendWithParams().

bccAssignedSubEditors()

SubmissionMailTemplate::bccAssignedSubEditors	(		$submissionId,
			$stageId
	)

BCC this email to all assigned sub editors in the given stage

Parameters

$submissionId	int
$stageId	int

Definition at line 176 of file SubmissionMailTemplate.inc.php.

References _addUsers().

ccAssignedSubEditors()

SubmissionMailTemplate::ccAssignedSubEditors	(		$submissionId,
			$stageId
	)

CC this email to all assigned sub editors in the given stage

Parameters

$submissionId	int
$stageId	int

Returns

array of Users

Definition at line 167 of file SubmissionMailTemplate.inc.php.

References _addUsers().

log()

SubmissionMailTemplate::log

(

$request = null

)

Save the email in the submission email log.

Definition at line 121 of file SubmissionMailTemplate.inc.php.

References $submission, Mail\getBccString(), Mail\getBody(), Mail\getCcString(), Core\getCurrentDate(), DAORegistry\getDAO(), Mail\getFromString(), Mail\getRecipientString(), and Mail\getSubject().

Referenced by send().

send()

SubmissionMailTemplate::send

(

$request = null

)

See also

parent::send()

Parameters

$request

PKPRequest optional (used for logging purposes)

Definition at line 76 of file SubmissionMailTemplate.inc.php.

References log().

sendWithParams()

SubmissionMailTemplate::sendWithParams

(

$paramArray

)

Reimplemented from MailTemplate.

Definition at line 88 of file SubmissionMailTemplate.inc.php.

References assignParams(), Mail\getBody(), Mail\getSubject(), MailTemplate\send(), Mail\setBody(), and Mail\setSubject().

setContext()

SubmissionMailTemplate::setContext

(

$context

)

Set the context this message is associated with.

Parameters

$context

object

Definition at line 114 of file SubmissionMailTemplate.inc.php.

References $context.

setEventType()

SubmissionMailTemplate::setEventType

(

$eventType

)

Add logging properties to this email.

Parameters

$eventType

int

Definition at line 106 of file SubmissionMailTemplate.inc.php.

toAssignedSubEditors()

SubmissionMailTemplate::toAssignedSubEditors	(		$submissionId,
			$stageId
	)

Send this email to all assigned sub editors in the given stage

Parameters

$submissionId	int
$stageId	int

Definition at line 157 of file SubmissionMailTemplate.inc.php.

References _addUsers().

Field Documentation

$context

object SubmissionMailTemplate::$context

the associated context

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

Referenced by __construct(), and setContext().

$logEventType

int SubmissionMailTemplate::$logEventType

Event type of this email for logging purposes

Definition at line 38 of file SubmissionMailTemplate.inc.php.

$submission

object SubmissionMailTemplate::$submission

the associated submission

Definition at line 26 of file SubmissionMailTemplate.inc.php.

Referenced by __construct(), assignParams(), and log().

---

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

• SubmissionMailTemplate.inc.php