LocaleEmailTemplate Class Reference

Inheritance diagram for LocaleEmailTemplate:

List of all members.

Public Member Functions
	addLocale ($locale)
	getBody ($locale)
	getDescription ($locale)
	getLocales ()
	getSubject ($locale)
	isCustomTemplate ()
	LocaleEmailTemplate ()
	setBody ($locale, $body)
	setCustomTemplate ($isCustomTemplate)
	setDescription ($locale, $description)
	setSubject ($locale, $subject)

---

Detailed Description

Email template with data for all supported locales.

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

---

Member Function Documentation

LocaleEmailTemplate.addLocale

(

$

locale

)

Add a new locale to store data for.

Parameters:

$locale

string

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

LocaleEmailTemplate.getBody

(

$

locale

)

Get body of email template.

Parameters:

$locale

string

Returns:

string

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

LocaleEmailTemplate.getDescription

(

$

locale

)

Get description of email template.

Parameters:

$locale

string

Returns:

string

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

LocaleEmailTemplate.getLocales

(

)

Get set of supported locales for this template.

Returns:

array

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

LocaleEmailTemplate.getSubject

(

$

locale

)

Get subject of email template.

Parameters:

$locale

string

Returns:

string

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

LocaleEmailTemplate.isCustomTemplate

(

)

Determine whether or not this is a custom email template (ie one that was created by the journal manager and is not part of the system upon installation)

Reimplemented from BaseEmailTemplate.

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

Referenced by setCustomTemplate().

LocaleEmailTemplate.LocaleEmailTemplate

(

)

Constructor.

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

LocaleEmailTemplate.setBody	(	$	locale,
		$	body
	)

Set body of email template.

Parameters:

	$locale	string
	$body	string

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

LocaleEmailTemplate.setCustomTemplate

(

$

isCustomTemplate

)

Set whether or not this is a custom template.

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

References isCustomTemplate().

LocaleEmailTemplate.setDescription	(	$	locale,
		$	description
	)

Set description of email template.

Parameters:

	$locale	string
	$description	string

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

LocaleEmailTemplate.setSubject	(	$	locale,
		$	subject
	)

Set subject of email template.

Parameters:

	$locale	string
	$subject	string

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

---

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

• classes/mail/EmailTemplate.inc.php