Public Member Functions

MonographMailTemplate Class Reference

Subclass of MailTemplate for sending emails related to monographs. More...

Inheritance diagram for MonographMailTemplate:
MailTemplate

List of all members.

Public Member Functions

 _addUsers ($monographId, $roleId, $stageId, $method)
 assignParams ($paramArray=array())
 bccAssignedSeriesEditors ($monographId, $stageId)
 ccAssignedSeriesEditors ($monographId, $stageId)
 log ($request=null)
 MonographMailTemplate ($monograph, $emailKey=null, $locale=null, $enableAttachments=null, $press=null, $includeSignature=true)
 send ($request=null)
 sendWithParams ($paramArray)
 setEventType ($eventType)
 setPress ($press)
 toAssignedSeriesEditors ($monographId, $stageId)

Detailed Description

Subclass of MailTemplate for sending emails related to monographs.

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

Definition at line 22 of file MonographMailTemplate.inc.php.

Member Function Documentation

MonographMailTemplate._addUsers ( $  monographId,
$  roleId,
$  stageId,
$  method 
)

Private method to fetch the requested users and add to the email

Parameters:
$monographId int
$roleId int
$stageId int
$method string one of addRecipient, addCC, or addBCC
Returns:
array of Users (note, this differs from OxS which returns EditAssignment objects)

Definition at line 195 of file MonographMailTemplate.inc.php.

Referenced by bccAssignedSeriesEditors(), ccAssignedSeriesEditors(), and toAssignedSeriesEditors().

MonographMailTemplate.assignParams ( $  paramArray = array()  ) 

Assigns values to e-mail parameters.

Parameters:
$paramArray array
Returns:
void

Reimplemented from MailTemplate.

Definition at line 48 of file MonographMailTemplate.inc.php.

References Request.getPress().

Referenced by sendWithParams().

MonographMailTemplate.bccAssignedSeriesEditors ( $  monographId,
$  stageId 
)

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

Parameters:
$monographId int
$stageId int

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

References _addUsers().

MonographMailTemplate.ccAssignedSeriesEditors ( $  monographId,
$  stageId 
)

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

Parameters:
$monographId int
$stageId int
Returns:
array of Users (note, this differs from OxS which returns EditAssignment objects)

Definition at line 174 of file MonographMailTemplate.inc.php.

References _addUsers().

MonographMailTemplate.log ( $  request = null  ) 

Save the email in the monograph email log.

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

Referenced by send().

MonographMailTemplate.MonographMailTemplate ( $  monograph,
$  emailKey = null,
$  locale = null,
$  enableAttachments = null,
$  press = null,
$  includeSignature = true 
)

Constructor.

Parameters:
$monograph object
$emailKey string optional
$locale string optional
$enableAttachments boolean optional
$press object optional
$includeSignature boolean optional
See also:
MailTemplate.MailTemplate()

Definition at line 43 of file MonographMailTemplate.inc.php.

References MailTemplate.MailTemplate().

MonographMailTemplate.send ( $  request = null  ) 
See also:
parent.send()
Parameters:
$request PKPRequest optional (used for logging purposes)

Reimplemented from MailTemplate.

Definition at line 66 of file MonographMailTemplate.inc.php.

References log().

Referenced by sendWithParams().

MonographMailTemplate.sendWithParams ( $  paramArray  ) 
See also:
parent.sendWithParams()

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

References assignParams(), and send().

MonographMailTemplate.setEventType ( $  eventType  ) 

Add logging properties to this email.

Parameters:
$eventType int

Definition at line 98 of file MonographMailTemplate.inc.php.

MonographMailTemplate.setPress ( $  press  ) 

Set the press this message is associated with.

Parameters:
$press object

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

MonographMailTemplate.toAssignedSeriesEditors ( $  monographId,
$  stageId 
)

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

Parameters:
$monographId int
$stageId int

Definition at line 164 of file MonographMailTemplate.inc.php.

References _addUsers().

The documentation for this class was generated from the following file:
Generated on Mon Sep 17 2012 13:58:58 for Open Monograph Press by  doxygen 1.7.1