Skip to end of metadata
Go to start of metadata
You are viewing an old version of this page. View the current version. Compare with Current  |   View Page History
Under Construction
This proposal is under construction and is not ready for review.

<ac:macro ac:name="unmigrated-inline-wiki-markup"><ac:plain-text-body><![CDATA[

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: 7)

Table of Contents

1. Overview

Zend_Log_Writer_Mail is a Zend_Log writer for sending log entries to recipient(s) via email.

Proposal of this class is motivated by use in a batch script environment, where logs need to be kept, but developers also need to be notified via email of any notices, warnings, errors, etc.; will be described below in "Use Cases."

2. References

3. Component Requirements, Constraints, and Acceptance Criteria

  • This component will email log entries to a given recipient or recipients
  • This component will adhere to standard Zend_Log_Writer formatting and filtering conventions

4. Dependencies on Other Framework Components

  • Zend_Mail
  • Zend_Log_Writer_Abstract
  • Zend_Log_Exception

5. Theory of Operation

User instantiates a Zend_Mail object and populates it with data for recipients that should be notified if any log entries. Zend_Mail object is then passed to constructor for Zend_Log_Writer_Mail object.

Zend_Log_Writer_Mail::_write() builds up an array of log entry lines to use as the body of the email message to the recipients.

Because an email should be sent upon the call of Zend_Log_Writer_Mail::_write(), the email should be sent upon the call to shutdown() if there are log entry lines to use in the body.

Once email has been sent to recipients, reference to Zend_Mail object is removed.

6. Milestones / Tasks

Describe some intermediate state of this component in terms of design notes, additional material added to this page, and / code. Note any significant dependencies here, such as, "Milestone #3 can not be completed until feature Foo has been added to ZF component XYZ." Milestones will be required for acceptance of future proposals. They are not hard, and many times you will only need to think of the first three below.

  • Milestone 1: [DONE] Initial class code is drafted
  • Milestone 2: (unclear on use of incubator code at this point, but assume getting code there will be milestone #2)
  • Milestone 3: Units are created, work, and are checked into SVN.
  • Milestone 4: Initial documentation exists.

7. Class Index

  • Zend_Log_Writer_Mail

8. Use Cases

UC-01
UC-02
UC-03

9. Class Skeletons

]]></ac:plain-text-body></ac:macro>

Labels:
None
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.