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

Public Member Functions

 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

Describes basic email template properties.

Email template base class.

See Also
EmailTemplateDAO

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

Member Function Documentation

BaseEmailTemplate::BaseEmailTemplate ( )

Constructor.

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

BaseEmailTemplate::getAssocId ( )

Get ID of journal/conference/...

Returns
int

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

References DataObject\getData().

BaseEmailTemplate::getAssocType ( )

Get association type.

Returns
int

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

References DataObject\getData().

BaseEmailTemplate::getCanDisable ( )

Check if email template is allowed to be disabled.

Returns
boolean

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

References DataObject\getData().

BaseEmailTemplate::getEmailId ( )

Get ID of email template.

Returns
int

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

References DataObject\getData().

BaseEmailTemplate::getEmailKey ( )

Get key of email template.

Returns
string

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

References DataObject\getData().

BaseEmailTemplate::getEnabled ( )

Get the enabled setting of email template.

Returns
boolean

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

References DataObject\getData().

BaseEmailTemplate::getFromRoleId ( )

Get sender role ID.

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

References DataObject\getData().

Referenced by getFromRoleName().

& BaseEmailTemplate::getFromRoleName ( )

Get sender role name.

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

References DAORegistry\getDAO(), and getFromRoleId().

BaseEmailTemplate::getToRoleId ( )

Get recipient role ID.

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

References DataObject\getData().

Referenced by getToRoleName().

& BaseEmailTemplate::getToRoleName ( )

Get recipient role name.

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

References DAORegistry\getDAO(), and getToRoleId().

BaseEmailTemplate::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 71 of file EmailTemplate.inc.php.

BaseEmailTemplate::setAssocId (   $assocId)

Set ID of journal/conference/...

Parameters
$assocIdint

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

References DataObject\setData().

BaseEmailTemplate::setAssocType (   $assocType)

Set association type.

Parameters
$assocTypeint

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

References DataObject\setData().

BaseEmailTemplate::setCanDisable (   $canDisable)

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

Parameters
$canDisableboolean

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

References DataObject\setData().

BaseEmailTemplate::setEmailId (   $emailId)

Set ID of email template.

Parameters
$emailIdint

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

References DataObject\setData().

BaseEmailTemplate::setEmailKey (   $emailKey)

Set key of email template.

Parameters
$emailKeystring

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

References DataObject\setData().

BaseEmailTemplate::setEnabled (   $enabled)

Set the enabled setting of email template.

Parameters
$enabledboolean

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

References DataObject\setData().

BaseEmailTemplate::setFromRoleId (   $fromRoleId)

Set sender role ID.

Parameters
$fromRoleIdint

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

References DataObject\setData().

BaseEmailTemplate::setToRoleId (   $toRoleId)

Set recipient role ID.

Parameters
$toRoleIdint

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

References DataObject\setData().


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