Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
EmailTemplateDAO Class Reference
Inheritance diagram for EmailTemplateDAO:
PKPEmailTemplateDAO DAO

Public Member Functions

 customTemplateExistsByKey ($emailKey, $journalId)
 
 deleteEmailTemplateByKey ($emailKey, $journalId)
 
 deleteEmailTemplatesByJournal ($journalId)
 
getBaseEmailTemplate ($emailKey, $journalId)
 
getEmailTemplate ($emailKey, $locale, $journalId)
 
getEmailTemplates ($locale, $journalId, $rangeInfo=null)
 
getLocaleEmailTemplate ($emailKey, $journalId)
 
 templateExistsByKey ($emailKey, $journalId=null)
 
- Public Member Functions inherited from PKPEmailTemplateDAO
_returnBaseEmailTemplateFromRow (&$row)
 
_returnEmailTemplateFromRow (&$row, $isCustomTemplate=null)
 
_returnLocaleEmailTemplateFromRow (&$row)
 
 customTemplateExistsByKey ($emailKey, $assocType, $assocId)
 
 deleteDefaultEmailTemplatesByLocale ($locale)
 
 deleteEmailTemplateByKey ($emailKey, $assocType, $assocId)
 
 deleteEmailTemplatesByAssoc ($assocType, $assocId)
 
 deleteEmailTemplatesByLocale ($locale)
 
getBaseEmailTemplate ($emailKey, $assocType, $assocId)
 
getEmailTemplate ($emailKey, $locale, $assocType, $assocId)
 
getEmailTemplates ($locale, $assocType, $assocId, $rangeInfo=null)
 
 getInsertEmailId ()
 
getLocaleEmailTemplate ($emailKey, $assocType, $assocId)
 
 insertBaseEmailTemplate (&$emailTemplate)
 
 insertLocaleEmailTemplate (&$emailTemplate)
 
 installEmailTemplateData ($templateDataFile, $returnSql=false, $emailKey=null)
 
 installEmailTemplates ($templatesFile, $returnSql=false, $emailKey=null, $skipExisting=false)
 
 PKPEmailTemplateDAO ()
 
 templateExistsByKey ($emailKey, $assocType=null, $assocId=null)
 
 updateBaseEmailTemplate (&$emailTemplate)
 
 updateLocaleEmailTemplate (&$emailTemplate)
 
 updateLocaleEmailTemplateData (&$emailTemplate)
 
- Public Member Functions inherited from DAO
 concat ()
 
 convertFromDB ($value, $type)
 
 convertToDB ($value, &$type)
 
 DAO ($dataSource=null, $callHooks=true)
 
 dateFromDB ($d)
 
 datetimeFromDB ($dt)
 
 datetimeToDB ($dt)
 
 dateToDB ($d)
 
 flushCache ()
 
 formatDateToDB ($date, $defaultNumWeeks=null, $acceptPastDate=true)
 
 getAffectedRows ()
 
 getDataChangedEvent ($elementId=null, $parentElementId=null)
 
getDataSource ()
 
 getDirectionMapping ($direction)
 
 getDriver ()
 
 getInsertId ($table= '', $id= '', $callHooks=true)
 
 getType ($value)
 
 replace ($table, $arrFields, $keyCols)
 
retrieve ($sql, $params=false, $callHooks=true)
 
retrieveCached ($sql, $params=false, $secsToCache=3600, $callHooks=true)
 
retrieveLimit ($sql, $params=false, $numRows=false, $offset=false, $callHooks=true)
 
retrieveRange ($sql, $params=false, $dbResultRange=null, $callHooks=true)
 
 setCacheDir ()
 
 setDataSource (&$dataSource)
 
 update ($sql, $params=false, $callHooks=true, $dieOnError=true)
 
 updateDataObjectSettings ($tableName, &$dataObject, $idArray)
 

Additional Inherited Members

- Public Attributes inherited from DAO
 $_dataSource
 

Detailed Description

Operations for retrieving and modifying Email Template objects.

See Also
EmailTemplate

Definition at line 20 of file EmailTemplateDAO.inc.php.

Member Function Documentation

EmailTemplateDAO::customTemplateExistsByKey (   $emailKey,
  $journalId 
)

Check if a custom template exists with the given email key for a journal.

Parameters
$emailKeystring
$journalIdint
Returns
boolean

Definition at line 100 of file EmailTemplateDAO.inc.php.

EmailTemplateDAO::deleteEmailTemplateByKey (   $emailKey,
  $journalId 
)

Delete an email template by key.

Parameters
$emailKeystring
$journalIdint

Definition at line 60 of file EmailTemplateDAO.inc.php.

EmailTemplateDAO::deleteEmailTemplatesByJournal (   $journalId)

Delete all email templates for a specific journal.

Parameters
$journalIdint

Definition at line 80 of file EmailTemplateDAO.inc.php.

& EmailTemplateDAO::getBaseEmailTemplate (   $emailKey,
  $journalId 
)

Retrieve a base email template by key.

Parameters
$emailKeystring
$journalIdint
Returns
BaseEmailTemplate

Definition at line 27 of file EmailTemplateDAO.inc.php.

& EmailTemplateDAO::getEmailTemplate (   $emailKey,
  $locale,
  $journalId 
)

Retrieve an email template by key.

Parameters
$emailKeystring
$localestring
$journalIdint
Returns
EmailTemplate

Definition at line 50 of file EmailTemplateDAO.inc.php.

& EmailTemplateDAO::getEmailTemplates (   $locale,
  $journalId,
  $rangeInfo = null 
)

Retrieve all email templates.

Parameters
$localestring
$journalIdint
$rangeInfoobject optional
Returns
array Email templates

Definition at line 71 of file EmailTemplateDAO.inc.php.

& EmailTemplateDAO::getLocaleEmailTemplate (   $emailKey,
  $journalId 
)

Retrieve localized email template by key.

Parameters
$emailKeystring
$journalIdint
Returns
LocaleEmailTemplate

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

EmailTemplateDAO::templateExistsByKey (   $emailKey,
  $journalId = null 
)

Check if a template exists with the given email key for a journal.

Parameters
$emailKeystring
$journalIdint
Returns
boolean

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


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