Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
SubmissionMailTemplate Class Reference
Inheritance diagram for SubmissionMailTemplate:
MailTemplate Mail DataObject MonographMailTemplate

Public Member Functions

 bccAssignedSubEditors ($submissionId, $stageId)
 
 ccAssignedSubEditors ($submissionId, $stageId)
 
 log ($request=null)
 
 send ($request=null)
 
 sendWithParams ($paramArray)
 
 setContext ($context)
 
 setEventType ($eventType)
 
 SubmissionMailTemplate ($submission, $emailKey=null, $locale=null, $enableAttachments=null, $context=null, $includeSignature=true)
 
 toAssignedSubEditors ($submissionId, $stageId)
 
- Public Member Functions inherited from MailTemplate
 _clearAttachments ($userId)
 
 _handleAttachments ($userId)
 
 addPersistAttachment ($temporaryFile)
 
 assignParams ($paramArray=array())
 
 clearRecipients ($clearHeaders=true)
 
 displayEditForm ($formActionUrl, $hiddenFormParams=null, $alternateTemplate=null, $additionalParameters=array())
 
 getAddressFieldsEnabled ()
 
 hasErrors ()
 
 isEnabled ()
 
 MailTemplate ($emailKey=null, $locale=null, $enableAttachments=null, $context=null, $includeSignature=true)
 
processAddresses ($currentList, &$newAddresses)
 
 send ($clearAttachments=true)
 
 sendWithParams ($paramArray)
 
 setAddressFieldsEnabled ($addressFieldsEnabled)
 
- Public Member Functions inherited from Mail
 addAttachment ($filePath, $fileName= '', $contentType= '', $contentDisposition= 'attachment')
 
 addBcc ($email, $name= '')
 
 addCc ($email, $name= '')
 
 addHeader ($name, $content)
 
 addPrivateParam ($name, $value)
 
 addRecipient ($email, $name= '')
 
 clearAllRecipients ()
 
 encodeDisplayName ($displayName, $send=false)
 
 getAddressArrayString ($addresses, $includeNames=true, $send=false)
 
getAttachments ()
 
 getBccs ()
 
 getBccString ()
 
 getBody ()
 
 getCcs ()
 
 getCcString ()
 
 getContentType ()
 
 getEnvelopeSender ()
 
 getFrom ()
 
 getFromString ($send=false)
 
 getHeaders ()
 
 getRecipients ()
 
 getRecipientString ()
 
 getReplyTo ()
 
 getSubject ()
 
 hasAttachments ()
 
 Mail ()
 
 promoteCcsIfNoRecipients ()
 
 send ()
 
 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)
 
 DataObject ()
 
 extractMetadata ($metadataSchema)
 
 getAdditionalMetadataFieldNames ()
 
getAllData ()
 
getData ($key, $locale=null)
 
 getHasLoadableAdapters ()
 
 getId ()
 
 getLocaleMetadataFieldNames ()
 
getLocalizedData ($key)
 
 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)
 
 upcastTo ($targetObject)
 

Public Attributes

 $context
 
 $logEventType
 
 $submission
 
- Public Attributes inherited from MailTemplate
 $addressFieldsEnabled
 
 $bccSender
 
 $context
 
 $emailKey
 
 $enabled
 
 $errorMessages
 
 $includeSignature
 
 $locale
 
 $persistAttachments
 
 $skip
 
- Public Attributes inherited from Mail
 $privateParams
 
- Public Attributes inherited from DataObject
 $_data = array()
 
 $_extractionAdaptersLoaded = false
 
 $_hasLoadableAdapters = false
 
 $_injectionAdaptersLoaded = false
 
 $_metadataExtractionAdapters = array()
 
 $_metadataInjectionAdapters = array()
 

Protected Member Functions

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

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.

Member Function Documentation

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

Fetch the requested users and add to the email

Parameters
$submissionIdint
$roleIdint
$stageIdint
$methodstring one of addRecipient, addCC, or addBCC
Returns
array of Users

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

Referenced by ccAssignedSubEditors().

SubmissionMailTemplate::bccAssignedSubEditors (   $submissionId,
  $stageId 
)

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

Parameters
$submissionIdint
$stageIdint

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

Referenced by MonographMailTemplate\bccAssignedSeriesEditors().

SubmissionMailTemplate::ccAssignedSubEditors (   $submissionId,
  $stageId 
)

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

Parameters
$submissionIdint
$stageIdint
Returns
array of Users

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

References _addUsers().

Referenced by MonographMailTemplate\ccAssignedSeriesEditors().

SubmissionMailTemplate::log (   $request = null)

Save the email in the submission email log.

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

SubmissionMailTemplate::send (   $request = null)
See Also
parent::send()
Parameters
$requestPKPRequest optional (used for logging purposes)

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

SubmissionMailTemplate::sendWithParams (   $paramArray)

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

SubmissionMailTemplate::setContext (   $context)

Set the context this message is associated with.

Parameters
$contextobject

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

SubmissionMailTemplate::setEventType (   $eventType)

Add logging properties to this email.

Parameters
$eventTypeint

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

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

Constructor.

Parameters
$submissionSubmission
$emailKeystring optional
$localestring optional
$enableAttachmentsboolean optional
$contextobject optional
$includeSignatureboolean optional
See Also
MailTemplate::MailTemplate()

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

SubmissionMailTemplate::toAssignedSubEditors (   $submissionId,
  $stageId 
)

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

Parameters
$submissionIdint
$stageIdint

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

Referenced by MonographMailTemplate\toAssignedSeriesEditors().

Member Data Documentation

object SubmissionMailTemplate::$context

the associated context

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

Referenced by MonographMailTemplate\MonographMailTemplate().

int SubmissionMailTemplate::$logEventType

Event type of this email for logging purposes

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

object SubmissionMailTemplate::$submission

the associated submission

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

Referenced by MonographMailTemplate\MonographMailTemplate().


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