Zend Framework: Email templating with layouts & views

James — Wed, 02 Dec 2009 16:14:24 +0000

This is a solution that I came up with for sending out welcome emails, comment notifications, etc, with nice standardized HTML & text layouts, using a few components of the Zend Framework.

Basically you create a view (here called $renderer) and a layout ($layout), then render your views and layouts for both HTML and text versions. My file tree looks like this:

application/
	emails/
		welcome.html.phtml
		welcome.text.phtml
		layouts/
			layout.html.phtml
			layout.text.phtml

So, ‘welcome’ would be your template name, with html and text versions. The layout is what you want wrapped around either version of every email you send out (header graphics, font settings, contact info, etc).

I keep all of my mail functions in one class, creating a new function for each email that needs to be sent out regularly in an automatic fashion. You could even use this for newsletters, but I prefer more robust environments like MailChimp or CampaignMonitor for that sort of thing.

This simple function handles all the rendering, file paths, etc. It just needs to be called with the proper template name, and an array of items to be passed to the view renderer.

Here’s the meat of it:

/**
 * getMailContent
 * Renders mailer content in text and html and passes it back as an array('html'=>content,'text'=>content)
 *
 * @param string $templatename the name of the email template to use (APP/emails/[name].[format].phtml)
 * @param array $substitutions key=>value array of variables to pass to the view renderers
 * @return array
 */
public function getMailContent($templatename, $substitutions) {
 
    // create a view renderer and set it to app_path/emails/
    $renderer = new Zend_View();
    $renderer-&gt;setScriptPath(realpath(APPLICATION_PATH . '/emails/'));
 
    // create a layout object and set it to app_path/emails/layouts
    $layout = new Zend_Layout(APPLICATION_PATH . '/emails/layouts/');
    $layout-&gt;setView($renderer); // this probably isn't even necessary
 
    // assign all substitutions (e.g. view variables) to the view renderer
    foreach ($substitutions as $key =&gt; $sub) $renderer-&gt;$key = $sub;
 
    $output = array(); // output array        
 
    // render text version of template & assign to output['text']
    $layout-&gt;content = $renderer-&gt;render($templatename . '.text.phtml');
    $layout-&gt;setLayout('layout.text');
    $output['text'] = $layout-&gt;render();
 
    // render html version of template & assign to output['html']
    $layout-&gt;content = $renderer-&gt;render($templatename . '.html.phtml');
    $layout-&gt;setLayout('layout.html');
    $output['html'] = $layout-&gt;render();
 
    // all done, return output
    return $output;
 
}

Nice and simple, huh? All you need to do is call it and then assign the output to your Zend_Mail object like so:

        $bodies = $this-&gt;getMailContent('new_comment', array(
            'comment' =&gt; $comment,
            'comment_list' =&gt; $comment_list,
            'comment_user' =&gt; $comment_user,
            'list_owner' =&gt; $list_owner
        ));
        $mail-&gt;setBodyHtml($bodies['html']);
        $mail-&gt;setBodyText($bodies['text']);

Your email template accesses the variables passed to it just as it would a normal view script:

$this-&gt;[variable]

Commentary / suggestions / etc welcome in comments.

Tweet This Post Digg This Post Post to Reddit Stumble This Post

TK Studios » zend framework

Zend Framework: Email templating with layouts & views