Open Journal Systems  2.4.4
 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 ()
 
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 with data for all supported locales.

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

Member Function Documentation

LocaleEmailTemplate::addLocale (   $locale)

Add a new locale to store data for.

Parameters
$localestring

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

LocaleEmailTemplate::getBody (   $locale)

Get body of email template.

Parameters
$localestring
Returns
string

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

LocaleEmailTemplate::getDescription (   $locale)

Get description of email template.

Parameters
$localestring
Returns
string

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

LocaleEmailTemplate::getLocales ( )

Get set of supported locales for this template.

Returns
array

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

LocaleEmailTemplate::getSubject (   $locale)

Get subject of email template.

Parameters
$localestring
Returns
string

Definition at line 263 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 216 of file EmailTemplate.inc.php.

Referenced by setCustomTemplate().

LocaleEmailTemplate::LocaleEmailTemplate ( )

Constructor.

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

LocaleEmailTemplate::setBody (   $locale,
  $body 
)

Set body of email template.

Parameters
$localestring
$bodystring

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

LocaleEmailTemplate::setCustomTemplate (   $isCustomTemplate)

Set whether or not this is a custom template.

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

References isCustomTemplate().

LocaleEmailTemplate::setDescription (   $locale,
  $description 
)

Set description of email template.

Parameters
$localestring
$descriptionstring

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

LocaleEmailTemplate::setSubject (   $locale,
  $subject 
)

Set subject of email template.

Parameters
$localestring
$subjectstring

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


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