EmailTemplateDAO Class Reference

Operations for retrieving and modifying Email Template objects. More...

List of all members.

Public Member Functions

 customTemplateExistsByKey ($emailKey, $conferenceId)
 deleteEmailTemplateByKey ($emailKey, $conferenceId)
 deleteEmailTemplatesByConference ($conferenceId)
getBaseEmailTemplate ($emailKey, $conferenceId)
getEmailTemplate ($emailKey, $locale, $conferenceId)
getEmailTemplates ($locale, $conferenceId, $rangeInfo=null)
getLocaleEmailTemplate ($emailKey, $conferenceId)
 templateExistsByKey ($emailKey, $conferenceId)


Detailed Description

Operations for retrieving and modifying Email Template objects.

See also:
EmailTemplate

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


Member Function Documentation

EmailTemplateDAO.customTemplateExistsByKey ( emailKey,
conferenceId 
)

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

Parameters:
$emailKey string
$conferenceId int
Returns:
boolean

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

EmailTemplateDAO.deleteEmailTemplateByKey ( emailKey,
conferenceId 
)

Delete an email template by key.

Parameters:
$emailKey string
$conferenceId int

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

EmailTemplateDAO.deleteEmailTemplatesByConference ( conferenceId  ) 

Delete all email templates for a specific conference.

Parameters:
$conferenceId int

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

& EmailTemplateDAO.getBaseEmailTemplate ( emailKey,
conferenceId 
)

Retrieve a base email template by key.

Parameters:
$emailKey string
$conferenceId int
Returns:
BaseEmailTemplate

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

& EmailTemplateDAO.getEmailTemplate ( emailKey,
locale,
conferenceId 
)

Retrieve an email template by key.

Parameters:
$emailKey string
$locale string
$conferenceId int
Returns:
EmailTemplate

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

& EmailTemplateDAO.getEmailTemplates ( locale,
conferenceId,
rangeInfo = null 
)

Retrieve all email templates.

Parameters:
$locale string
$conferenceId int
$rangeInfo object optional
Returns:
array Email templates

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

& EmailTemplateDAO.getLocaleEmailTemplate ( emailKey,
conferenceId 
)

Retrieve localized email template by key.

Parameters:
$emailKey string
$conferenceId int
Returns:
LocaleEmailTemplate

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

EmailTemplateDAO.templateExistsByKey ( emailKey,
conferenceId 
)

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

Parameters:
$emailKey string
$conferenceId int
Returns:
boolean

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


The documentation for this class was generated from the following file:
Generated on 25 Jul 2013 for Open Conference Systems by  doxygen 1.4.7