Open Journal Systems  3.3.0
EmailTemplate Class Reference
Inheritance diagram for EmailTemplate:
DataObject

Public Member Functions

 getAssocId ()
 
 getBody ()
 
 getCanDisable ()
 
 getEmailId ()
 
 getEmailKey ()
 
 getEnabled ()
 
 getFromRoleId ()
 
 getSubject ()
 
 getToRoleId ()
 
 isCustomTemplate ()
 
 setAssocId ($assocId)
 
 setBody ($body)
 
 setCanDisable ($canDisable)
 
 setEmailId ($emailId)
 
 setEmailKey ($key)
 
 setEnabled ($enabled)
 
 setFromRoleId ($fromRoleId)
 
 setSubject ($subject)
 
 setToRoleId ($toRoleId)
 
- Public Member Functions inherited from DataObject
 __construct ()
 
 addSupportedMetadataAdapter ($metadataAdapter)
 
 extractMetadata ($metadataSchema)
 
 getAdditionalMetadataFieldNames ()
 
getAllData ()
 
 getDAO ()
 
getData ($key, $locale=null)
 
 getHasLoadableAdapters ()
 
 getId ()
 
 getLocaleMetadataFieldNames ()
 
 getLocalizedData ($key, $preferredLocale=null)
 
 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)
 
 unsetData ($key, $locale=null)
 
 upcastTo ($targetObject)
 

Additional Inherited Members

- Data Fields inherited from DataObject
 $_data = array()
 
 $_extractionAdaptersLoaded = false
 
 $_hasLoadableAdapters = false
 
 $_injectionAdaptersLoaded = false
 
 $_metadataExtractionAdapters = array()
 
 $_metadataInjectionAdapters = array()
 

Detailed Description

Describes basic email template properties.

See also
EmailTemplateDAO

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

Member Function Documentation

◆ getAssocId()

EmailTemplate::getAssocId ( )

Get ID of journal/conference/...

Deprecated:
3.2
Returns
int

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

References DataObject\getData().

◆ getBody()

EmailTemplate::getBody ( )

Get body of email template.

Deprecated:
3.2
Returns
string

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

References DataObject\getData().

◆ getCanDisable()

EmailTemplate::getCanDisable ( )

Check if email template is allowed to be disabled.

Deprecated:
3.2
Returns
boolean

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

References DataObject\getData().

◆ getEmailId()

EmailTemplate::getEmailId ( )

Get ID of email template.

Deprecated:
3.2
Returns
int

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

References DataObject\getData().

◆ getEmailKey()

EmailTemplate::getEmailKey ( )

Get key of email template.

Deprecated:
3.2
Returns
string

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

References DataObject\getData().

◆ getEnabled()

EmailTemplate::getEnabled ( )

Get the enabled setting of email template.

Deprecated:
3.2
Returns
boolean

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

References DataObject\getData().

◆ getFromRoleId()

EmailTemplate::getFromRoleId ( )

Get sender role ID.

Deprecated:
3.2

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

References DataObject\getData().

◆ getSubject()

EmailTemplate::getSubject ( )

Get subject of email template.

Deprecated:
3.2
Returns
string

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

References DataObject\getData().

◆ getToRoleId()

EmailTemplate::getToRoleId ( )

Get recipient role ID.

Deprecated:
3.2

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

References DataObject\getData().

◆ isCustomTemplate()

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)

Deprecated:
3.2

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

◆ setAssocId()

EmailTemplate::setAssocId (   $assocId)

Set ID of journal/conference/...

Deprecated:
3.2
Parameters
$assocIdint

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

References DataObject\setData().

◆ setBody()

EmailTemplate::setBody (   $body)

Set body of email template.

Deprecated:
3.2
Parameters
$bodystring

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

References DataObject\setData().

◆ setCanDisable()

EmailTemplate::setCanDisable (   $canDisable)

Set whether or not email template is allowed to be disabled.

Deprecated:
3.2
Parameters
$canDisableboolean

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

References DataObject\setData().

◆ setEmailId()

EmailTemplate::setEmailId (   $emailId)

Set ID of email template.

Deprecated:
3.2
Parameters
$emailIdint

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

References DataObject\setData().

◆ setEmailKey()

EmailTemplate::setEmailKey (   $key)

Set key of email template.

Deprecated:
3.2
Parameters
$keystring

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

References DataObject\setData().

◆ setEnabled()

EmailTemplate::setEnabled (   $enabled)

Set the enabled setting of email template.

Deprecated:
3.2
Parameters
$enabledboolean

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

References DataObject\setData().

◆ setFromRoleId()

EmailTemplate::setFromRoleId (   $fromRoleId)

Set sender role ID.

Parameters
$fromRoleIdint
Deprecated:
3.2

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

References DataObject\setData().

◆ setSubject()

EmailTemplate::setSubject (   $subject)

Set subject of email.

Deprecated:
3.2
Parameters
$subjectstring

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

References DataObject\setData().

◆ setToRoleId()

EmailTemplate::setToRoleId (   $toRoleId)

Set recipient role ID.

Deprecated:
3.2
Parameters
$toRoleIdint

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

References DataObject\setData().


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