Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
EmailTemplateDAO Class Reference
Inheritance diagram for EmailTemplateDAO:
PKPEmailTemplateDAO DAO

Public Member Functions

 customTemplateExistsByKey ($emailKey, $pressId)
 
 deleteEmailTemplateByKey ($emailKey, $pressId=null)
 
 deleteEmailTemplatesByPress ($pressId)
 
 EmailTemplateDAO ()
 
 getBaseEmailTemplate ($emailKey, $pressId)
 
 getEmailTemplate ($emailKey, $locale, $pressId)
 
 getEmailTemplates ($locale, $pressId, $rangeInfo=null)
 
 getLocaleEmailTemplate ($emailKey, $pressId)
 
 templateExistsByKey ($emailKey, $pressId)
 
- 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)
 
 getCustomTemplateKeys ($assocType, $assocId)
 
 getEmailTemplate ($emailKey, $locale, $assocType, $assocId)
 
 getEmailTemplates ($locale, $assocType, $assocId, $rangeInfo=null)
 
 getInsertId ()
 
 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 ()
 
getDataSource ()
 
 getDirectionMapping ($direction)
 
 getDriver ()
 
 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

- Static Public Member Functions inherited from DAO
static getDataChangedEvent ($elementId=null, $parentElementId=null)
 
- Public Attributes inherited from DAO
 $_dataSource
 
- Protected Member Functions inherited from DAO
 _getInsertId ($table= '', $id= '')
 

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,
  $pressId 
)

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

Parameters
$emailKeystring
$pressIdint
Returns
boolean

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

EmailTemplateDAO::deleteEmailTemplateByKey (   $emailKey,
  $pressId = null 
)

Delete an email template by key.

Parameters
$emailKeystring
$pressIdint optional

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

EmailTemplateDAO::deleteEmailTemplatesByPress (   $pressId)

Delete all email templates for a specific press.

Parameters
$pressIdint

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

EmailTemplateDAO::EmailTemplateDAO ( )

Constructor

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

EmailTemplateDAO::getBaseEmailTemplate (   $emailKey,
  $pressId 
)

Retrieve a base email template by key.

Parameters
$emailKeystring Email key
$pressIdint Press ID
Returns
BaseEmailTemplate Email template

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

EmailTemplateDAO::getEmailTemplate (   $emailKey,
  $locale,
  $pressId 
)

Retrieve an email template by key.

Parameters
$emailKeystring
$localestring
$pressIdint
Returns
EmailTemplate

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

EmailTemplateDAO::getEmailTemplates (   $locale,
  $pressId,
  $rangeInfo = null 
)

Retrieve all email templates.

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

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

EmailTemplateDAO::getLocaleEmailTemplate (   $emailKey,
  $pressId 
)

Retrieve localized email template by key.

Parameters
$emailKeystring
$pressIdint
Returns
LocaleEmailTemplate

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

EmailTemplateDAO::templateExistsByKey (   $emailKey,
  $pressId 
)

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

Parameters
$emailKeystring
$pressIdint
Returns
boolean

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


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