Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
EmailTemplate Class Reference
Inheritance diagram for EmailTemplate:
BaseEmailTemplate DataObject

Public Member Functions

 EmailTemplate ()
 
 getBody ()
 
 getLocale ()
 
 getSubject ()
 
 isCustomTemplate ()
 
 setBody ($body)
 
 setCustomTemplate ($isCustomTemplate)
 
 setLocale ($locale)
 
 setSubject ($subject)
 
- Public Member Functions inherited from BaseEmailTemplate
 BaseEmailTemplate ()
 
 getAssocId ()
 
 getAssocType ()
 
 getCanDisable ()
 
 getEmailId ()
 
 getEmailKey ()
 
 getEnabled ()
 
 getFromRoleId ()
 
getFromRoleName ()
 
 getToRoleId ()
 
getToRoleName ()
 
 isCustomTemplate ()
 
 setAssocId ($assocId)
 
 setAssocType ($assocType)
 
 setCanDisable ($canDisable)
 
 setEmailId ($emailId)
 
 setEmailKey ($emailKey)
 
 setEnabled ($enabled)
 
 setFromRoleId ($fromRoleId)
 
 setToRoleId ($toRoleId)
 
- Public Member Functions inherited from DataObject
 addSupportedMetadataAdapter (&$metadataAdapter)
 
 DataObject ($callHooks=true)
 
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)
 

Additional Inherited Members

- Public Attributes inherited from DataObject
 $_data = array()
 

Detailed Description

Email template for a specific locale.

Definition at line 299 of file EmailTemplate.inc.php.

Member Function Documentation

EmailTemplate::EmailTemplate ( )

Constructor.

Definition at line 304 of file EmailTemplate.inc.php.

EmailTemplate::getBody ( )

Get body of email template.

Returns
string

Definition at line 364 of file EmailTemplate.inc.php.

References DataObject\getData().

EmailTemplate::getLocale ( )

Get locale of email template.

Returns
string

Definition at line 332 of file EmailTemplate.inc.php.

References DataObject\getData().

EmailTemplate::getSubject ( )

Get subject of email template.

Returns
string

Definition at line 348 of file EmailTemplate.inc.php.

References DataObject\getData().

EmailTemplate::isCustomTemplate ( )

Determine whether or not this is a custom email template (ie one that was created by the journal/conference/... manager and is not part of the system upon installation)

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

Referenced by setCustomTemplate().

EmailTemplate::setBody (   $body)

Set body of email template.

Parameters
$bodystring

Definition at line 372 of file EmailTemplate.inc.php.

References DataObject\setData().

EmailTemplate::setCustomTemplate (   $isCustomTemplate)

Set whether or not this is a custom template.

Definition at line 311 of file EmailTemplate.inc.php.

References isCustomTemplate().

EmailTemplate::setLocale (   $locale)

Set locale of email template.

Parameters
$localestring

Definition at line 340 of file EmailTemplate.inc.php.

References DataObject\setData().

EmailTemplate::setSubject (   $subject)

Set subject of email.

Parameters
$subjectstring

Definition at line 356 of file EmailTemplate.inc.php.

References DataObject\setData().


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