Zend Framework: Zend_Log_Writer_Mail Component Proposal

Proposed Component Name	Zend_Log_Writer_Mail
Developer Notes	http://framework.zend.com/wiki/display/ZFDEV/Zend_Log_Writer_Mail
Proposers	Brian DeShong
Revision	1.0 - 26 January 2008 - Initial creation (wiki revision: 18)

Milestone 1: [DONE] Initial class code is drafted for proposal
Milestone 2: [DONE] Proposal finalized and readied for review
Milestone 3: Working prototype checked in to incubator for community review
Milestone 3: Unit tests are created with 90%+ code coverage (assume that we can't test the actual receiving of email?)
Milestone 4: Initial documentation completed

7. Class Index

Zend_Log_Writer_Mail

8. Use Cases

UC-01

$log = new Zend_Log();
$log->addWriter(new Zend_Log_Writer_Stream('php://stdout'));

$mail = new Zend_Mail();
$mail->setDefaultTransport(new Zend_Mail_Transport_Smtp());

$mail->setFrom('foo@example.org');
$mail->addTo('techlead@example.org');
$mail->addTo('devteam@example.org');
$mail->setSubject('Video transcoding -- ERRORS');

$mailWriter = new Zend_Log_Writer_Mail($mail);

// Email warnings and higher to recipients.
$mailWriter->addFilter(Zend_Log::WARN);

$log->addWriter($mailWriter);
...
$log->info('processing item X');
$log->err('failed to connect to video transcoding service');
$log->info('shutting down');

// Recipients only receive the err level message in their email.
// All log entries are written to STDOUT.

UC-02

$log = new Zend_Log();
$log->addWriter(new Zend_Log_Writer_Stream('php://stdout'));

$mail = new Zend_Mail();
$mail->setDefaultTransport(new Zend_Mail_Transport_Smtp());

$mail->setFrom('foo@example.org');
$mail->addTo('devteam@example.org');
$mail->setSubject('Video transcoding -- ERRORS');

$mailWriter = new Zend_Log_Writer_Mail($mail);

// Email warnings and higher to recipients.
$mailWriter->addFilter(Zend_Log::WARN);

$log->addWriter($mailWriter);

// Load up $items.

// Process items.
foreach ($items as $item) {
    $log->info('processing item X');
    // Process item
    $log->info('completed processing item X');
}

$log->info('shutting down');

// Only info messages were logged, so no email is sent to recipients.
// All log entries are written to STDOUT.

UC-03

$log = new Zend_Log();
$log->addWriter(new Zend_Log_Writer_Stream('php://stdout'));

$mail = new Zend_Mail();
$mail->setDefaultTransport(new Zend_Mail_Transport_Smtp());

$mail->setFrom('foo@example.org');
$mail->addTo('devteam@example.org');
$mail->setSubject('Video transcoding -- ERRORS');

$mailWriter = new Zend_Log_Writer_Mail($mail);

// Email warnings and higher to recipients.
$mailWriter->addFilter(Zend_Log::WARN);

$log->addWriter($mailWriter);

// Load up $items.

// Process items.
foreach ($items as $item) {
    try {
        $log->info('processing item X');
        // Process item
        $log->info('completed processing item X');
    } catch (Foo_Exception $e) {
        $log->error(
            'item X; ' . 
                'caught exception; ' .
                'continuing to next item; ' .
                'message = ' . $e->getMessage() . '; ' .
                'code = ' . $e->getCode() . '; ' .
                'trace = ' . $e->getTraceAsString());
    }
}

$log->info('shutting down');

// If any exceptions occurred, they are sent to recipients in email body.
// All log entries are written to STDOUT.

9. Class Skeletons

class Zend_Log_Writer_Mail extends Zend_Log_Writer_Abstract
{
    /**
     * Array of formatted lines to use as message body.
     * @var array
     */
    private $_linesToMail;

    /**
     * Zend_Mail instance to use
     * @var Zend_Mail
     */
    private $_mail;

    /**
     * Class constructor
     *
     * @param Zend_Mail $mail Mail instance
     */
    public function __construct(Zend_Mail $mail)
    {
        $this->_mail = $mail;
        $this->_formatter = new Zend_Log_Formatter_Simple();
        $this->_linesToMail = array();
    }

    /**
     * Places event line into array of lines to be used as message body.
     *
     * @param  array $event event data
     * @return void
     */
    protected function _write($event)
    {
        $this->_linesToMail[] = $this->_formatter->format($event);
    }

    /**
     * Sends mail to recipient(s) if log entries are present.
     *
     * @return void
     */
    public function shutdown()
    {
        // If there are lines to mail, use them as message body.
        if (!empty($this->_linesToMail)) {
            // Set body text to all lines meant to be mailed,
            // then send message.
            $this->_mail->setBodyText(implode('', $this->_linesToMail));

            $this->_mail->send();
        }

        // Note that we don't destroy $this->_mail as the user may
        // want to use that object after mail sending.
    }
}

Page Operations

Browse Space

Zend_Log_Writer_Mail

Labels

Zend Framework: Zend_Log_Writer_Mail Component Proposal

Table of Contents

1. Overview

2. References

3. Component Requirements, Constraints, and Acceptance Criteria

4. Dependencies on Other Framework Components

5. Theory of Operation

6. Milestones / Tasks

7. Class Index

8. Use Cases

9. Class Skeletons