EmailTemplate Class Reference

Inherits DataItem.

Public Member Functions
	EmailTemplate ()

Static Public Member Functions
static	getEmailTemplate ($name)
	Retrieves the named email templated. More...
static	templateExists ($name)
	Checks whether the named EmailTemplate exists. More...
static	setDefaultTemplate ($name, $recipients, $subject, $message, $class_name, $sender_email="")
	Create a default template for emails that are sent through Fakoli components (e.g., blog_published) More...

Public Attributes
	$fields

Detailed Description

Definition at line 40 of file email_template.inc.

Member Function Documentation

EmailTemplate()

EmailTemplate::EmailTemplate

(

)

Definition at line 109 of file email_template.inc.

     {
          $this->table = "email_template";
          $this->primary_key = "email_template_id";
          
          $this->DataItem(func_get_args());
     }

getEmailTemplate()

static EmailTemplate::getEmailTemplate (   $name )

static

Retrieves the named email templated.

Parameters

string

$name

the identifier for the email template

Returns

EmailTemplate the matching email template (null if not matched)

Definition at line 57 of file email_template.inc.

     {
          $emailTemplates = Query::create(EmailTemplate, "WHERE name=:n")
                                      ->bind(":n", $name)
                                      ->execute();
 
          return (count($emailTemplates) > 0) ? $emailTemplates[0] : null;
     }

setDefaultTemplate()

static EmailTemplate::setDefaultTemplate (   $name,   $recipients,   $subject,   $message,   $class_name,   $sender_email = ""  )

static

Create a default template for emails that are sent through Fakoli components (e.g., blog_published)

Parameters

string	$name
string	$recipients
string	$subject
string	$message
string	$class_name
string	$sender_email

Definition at line 89 of file email_template.inc.

     {
          $emailTemplates = Query::create(EmailTemplate, "WHERE name=:name")
               ->bind(":name", $name)
               ->execute();
          
          if(count($emailTemplates))
          {
               return;
          }
          
          $emailTemplate = new EmailTemplate();
          $emailTemplate->name = $name;
          $emailTemplate->class_name = $class_name;
          $emailTemplate->recipients = $recipients;
          $emailTemplate->subject = $subject;
          $emailTemplate->message = $message;
          $emailTemplate->save();
     }

templateExists()

static EmailTemplate::templateExists (   $name )

static

Checks whether the named EmailTemplate exists.

Parameters

string

$name

the identifier for the email template

Returns

boolean

Definition at line 71 of file email_template.inc.

     {
          return Query::create('EmailTemplate', "WHERE name=:n")
                         ->bind(":n", $name)
                         ->count() > 0;
     }

Member Data Documentation

$fields

EmailTemplate::$fields

Initial value:

= array(
                    "email_template_id"      =>   Number,
                    "class_name"             =>   String,
                    "name"                        =>   String,
                    "sender_email"           =>   String,
                    "recipients"             =>   Text,
                    "subject"                =>   String,
                    "message"                =>   HTML
     )

Definition at line 42 of file email_template.inc.

---

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

• C:/code/cms.sonjara.com/cms/components/email/datamodel/email_template.inc