EmailTemplateDAO Class Reference

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

List of all members.

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)

---

Detailed Description

Operations for retrieving and modifying Email Template objects.

See also:

EmailTemplate

Definition at line 19 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:

	$emailKey	string
	$pressId	int

Returns:

boolean

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

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

Delete an email template by key.

Parameters:

	$emailKey	string
	$pressId	int optional

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

EmailTemplateDAO.deleteEmailTemplatesByPress

(

$

pressId

)

Delete all email templates for a specific press.

Parameters:

$pressId

int

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

EmailTemplateDAO.EmailTemplateDAO

(

)

Constructor

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

& EmailTemplateDAO.getBaseEmailTemplate	(	$	emailKey,
		$	pressId
	)

Retrieve a base email template by key.

Parameters:

	$emailKey	string
	$pressId	int

Returns:

BaseEmailTemplate

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

& EmailTemplateDAO.getEmailTemplate	(	$	emailKey,
		$	locale,
		$	pressId
	)

Retrieve an email template by key.

Parameters:

	$emailKey	string
	$locale	string
	$pressId	int

Returns:

EmailTemplate

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

& EmailTemplateDAO.getEmailTemplates	(	$	locale,
		$	pressId,
		$	rangeInfo = null
	)

Retrieve all email templates.

Parameters:

	$locale	string
	$pressId	int
	$rangeInfo	object optional

Returns:

array Email templates

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

& EmailTemplateDAO.getLocaleEmailTemplate	(	$	emailKey,
		$	pressId
	)

Retrieve localized email template by key.

Parameters:

	$emailKey	string
	$pressId	int

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:

	$emailKey	string
	$pressId	int

Returns:

boolean

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

---

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

• classes/mail/EmailTemplateDAO.inc.php