Skip to end of metadata
Go to start of metadata

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

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

Zend Framework: Zend_Growl + Zend_Log_Writer_Growl Component Proposal

Proposed Component Name Zend_Growl + Zend_Log_Writer_Growl
Developer Notes http://framework.zend.com/wiki/display/ZFDEV/Zend_Growl + Zend_Log_Writer_Growl
Proposers Tom Graham
Zend Liaison Matthew Weier O'Phinney
Revision 1.1 - 21 September 2008: Initial Draft. (wiki revision: 9)

Table of Contents

1. Overview

Zend_Growl is a simple component for sending Growl notifications.
Zend_Log_Writer_Growl utilises Zend_Growl to send Growl notifications upon log events.

2. References

3. Component Requirements, Constraints, and Acceptance Criteria

  • This component will send network Growl notifications via UDP
  • This component will provide a log writer that sends Growl notifcations

4. Dependencies on Other Framework Components

  • Zend_Log_Writer_Abstract
  • Zend_Log_Filter_Priority
  • Zend_Log_Exception
  • Zend_Exception

5. Theory of Operation

6. Milestones / Tasks

  • Milestone 1: Design
  • Milestone 2: Working prototype checked into the incubator supporting use cases
  • Milestone 4: Unit tests exist, work, and are checked into SVN.
  • Milestone 5: Initial documentation exists.

7. Class Index

  • Zend_Growl
  • Zend_Log_Writer_Growl

8. Use Cases

UC-01

$growl = new Zend_Growl('127.0.0.1', 'password');
$growl->addNotification('Messages');
$growl->notify('Messages', 'Title', 'Message description', Noginn_Growl::PRIORITY_LOW, true);

UC-02

$growl = new Zend_Growl('127.0.0.1', 'password');
$writer = new Zend_Log_Writer_Growl($growl);
$logger = new Zend_Log($writer);

// Sends Growl notification with the Title 'Emergency'
$logger->emerg('Log message');

9. Class Skeletons

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

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

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

    <p>I think this should be made as a Zend_Log_Writer instead of new component.</p>

  2. Sep 21, 2008

    <p>Good idea, I think it would be good to have a Zend_Log_Writer component but also the standalone as well. I'll get to work on the log writer.</p>

  3. Oct 13, 2008

    <p>One principal issue we may have is that growl is mac-specific. Linux has similar functionality via specto, gnotify, and mumbles offer it – but they are not 1:1 comparisons in functionality. Would you be interested/willing to consider a more general purpose 'Notifier' component with various backends? You wouldn't need to write all adapters at once – Growl would be one adapter – but this would allow for extendibility and future-proof the component.</p>

    1. Oct 13, 2008

      <p>I like the idea of a Notifier component. There are lots of services out there that an application may want to "notify" of a particular event.</p>

    2. Oct 14, 2008

      <p>Sounds like a great idea to me. I'll have a play around and see what I can come up with.</p>

    3. Oct 15, 2008

      <p>This is much better- I think the idea of locking a component to a specific OS is nasty.</p>

  4. Oct 31, 2008

    <ac:macro ac:name="note"><ac:parameter ac:name="title">Zend Acceptance</ac:parameter><ac:rich-text-body>
    <p>We accept this proposal for conditional development in the extras incubator.</p>

    <p>We would like to see the component generalized to include a ZendX_Notifier component, with a Growl adapter. This will allow for additional adapters in the future targetting other notification protocols (such as gnotify, mumbles, etc.).</p></ac:rich-text-body></ac:macro>

  5. Mar 18, 2009

    <p>This proposal hasn't been updated in the last 6 months. Archiving for now.</p>

  6. Mar 19, 2009

    <p>I thought I archived this, and now it is in Extras Incubator. If it has been resurrected, please leave a note saying so. Re-archiving, but will not archive again if I see a comment saying that it has been resurrected.</p>

    1. Mar 19, 2009

      <p>Unfortunately I don't have the time to work on this component anymore.</p>

      <p>I did't move it out of the archive either <ac:emoticon ac:name="smile" /></p>