Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
LocaleEmailTemplate Class Reference
Inheritance diagram for LocaleEmailTemplate:
BaseEmailTemplate DataObject

Public Member Functions

 addLocale ($locale)
 
 getBody ($locale)
 
 getDescription ($locale)
 
 getLocales ()
 
 getSubject ($locale)
 
 isCustomTemplate ()
 
 LocaleEmailTemplate ()
 
 setBody ($locale, $body)
 
 setCustomTemplate ($isCustomTemplate)
 
 setDescription ($locale, $description)
 
 setSubject ($locale, $subject)
 
- Public Member Functions inherited from BaseEmailTemplate
 BaseEmailTemplate ()
 
 getAssocId ()
 
 getAssocType ()
 
 getCanDisable ()
 
 getEmailId ()
 
 getEmailKey ()
 
 getEnabled ()
 
 getFromRoleId ()
 
 getToRoleId ()
 
 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 ()
 
 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

 $localeData
 
- Public Attributes inherited from DataObject
 $_data = array()
 
 $_extractionAdaptersLoaded = false
 
 $_hasLoadableAdapters = false
 
 $_injectionAdaptersLoaded = false
 
 $_metadataExtractionAdapters = array()
 
 $_metadataInjectionAdapters = array()
 

Detailed Description

Email template with data for all supported locales.

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

Member Function Documentation

LocaleEmailTemplate::addLocale (   $locale)

Add a new locale to store data for.

Parameters
$localestring

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

LocaleEmailTemplate::getBody (   $locale)

Get body of email template.

Parameters
$localestring
Returns
string

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

LocaleEmailTemplate::getDescription (   $locale)

Get description of email template.

Parameters
$localestring
Returns
string

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

LocaleEmailTemplate::getLocales ( )

Get set of supported locales for this template.

Returns
array

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

LocaleEmailTemplate::getSubject (   $locale)

Get subject of email template.

Parameters
$localestring
Returns
string

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

LocaleEmailTemplate::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 203 of file EmailTemplate.inc.php.

LocaleEmailTemplate::LocaleEmailTemplate ( )

Constructor.

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

LocaleEmailTemplate::setBody (   $locale,
  $body 
)

Set body of email template.

Parameters
$localestring
$bodystring

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

LocaleEmailTemplate::setCustomTemplate (   $isCustomTemplate)

Set whether or not this is a custom template.

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

LocaleEmailTemplate::setDescription (   $locale,
  $description 
)

Set description of email template.

Parameters
$localestring
$descriptionstring

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

LocaleEmailTemplate::setSubject (   $locale,
  $subject 
)

Set subject of email template.

Parameters
$localestring
$subjectstring

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

Member Data Documentation

array LocaleEmailTemplate::$localeData

of localized email template data

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


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