PaperMailTemplate Class Reference

Subclass of MailTemplate for sending emails related to papers. This allows for paper-specific functionality like logging, etc. More...

Inheritance diagram for PaperMailTemplate:

MailTemplate List of all members.

Public Member Functions

 assignParams ($paramArray=array())
 ccAssignedDirectors ($paperId)
 ccAssignedTrackDirectors ($paperId)
 log ()
 PaperMailTemplate ($paper, $emailKey=null, $locale=null, $enableAttachments=null, $conference=null, $schedConf=null, $includeSignature=true, $ignorePostedData=false)
 send ()
 sendWithParams ($paramArray)
 setAssoc ($eventType, $assocType, $assocId)
 setConference ($conference)
 setSchedConf ($schedConf)
 toAssignedDirectors ($paperId)
 toAssignedTrackDirectors ($paperId)

Public Attributes

 $assocId
 $assocType
 $conference
 $eventType
 $paper
 $schedConf

Detailed Description

Subclass of MailTemplate for sending emails related to papers. This allows for paper-specific functionality like logging, etc.

Definition at line 19 of file PaperMailTemplate.inc.php.


Member Function Documentation

PaperMailTemplate.assignParams ( paramArray = array()  ) 

Assigns values to e-mail parameters.

Parameters:
$paramArray array
Returns:
void

Reimplemented from MailTemplate.

Definition at line 56 of file PaperMailTemplate.inc.php.

References $conference, $paper, $schedConf, Request.getConference(), and Request.getSchedConf().

Referenced by sendWithParams().

PaperMailTemplate.log (  ) 

Save the email in the paper email log.

Definition at line 132 of file PaperMailTemplate.inc.php.

References $paper, and PaperLog.logEmailEntry().

Referenced by send().

PaperMailTemplate.PaperMailTemplate ( paper,
emailKey = null,
locale = null,
enableAttachments = null,
conference = null,
schedConf = null,
includeSignature = true,
ignorePostedData = false 
)

Constructor.

Parameters:
$paper object
$emailType string optional
$locale string optional
$enableAttachments boolean optional
$conference object optional
$schedConf object optional
$includeSignature boolean optional
$ignorePostedData boolean optional
See also:
MailTemplate.MailTemplate()

Definition at line 51 of file PaperMailTemplate.inc.php.

References $conference, $paper, and $schedConf.

PaperMailTemplate.send (  ) 

See also:
parent.send()

Definition at line 74 of file PaperMailTemplate.inc.php.

References log().

Referenced by sendWithParams().

PaperMailTemplate.sendWithParams ( paramArray  ) 

See also:
parent.sendWithParams()

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

References assignParams(), and send().

PaperMailTemplate.setAssoc ( eventType,
assocType,
assocId 
)

Add a generic association between this email and some event type / type / ID tuple.

Parameters:
$eventType int
$assocType int
$assocId int

Definition at line 107 of file PaperMailTemplate.inc.php.

References $assocId, $assocType, and $eventType.

PaperMailTemplate.setConference ( conference  ) 

Set the conference this message is associated with.

Parameters:
$conference object

Definition at line 117 of file PaperMailTemplate.inc.php.

References $conference.

PaperMailTemplate.setSchedConf ( schedConf  ) 

Set the scheduled conference this message is associated with.

Parameters:
$schedConf object

Definition at line 125 of file PaperMailTemplate.inc.php.

References $schedConf.


The documentation for this class was generated from the following file:
Generated on 25 Jul 2013 for Open Conference Systems by  doxygen 1.4.7