| Current File : //opt/RZphp73/includes/doc/Net_Growl/html/index.html |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.8" />
<meta name="description" content="Send notifications to Growl from PHP on MACOSX and WINDOWS." />
<meta name="keywords" content="PEAR, Network, Notification, Growl" />
<title>Net_Growl</title>
<link rel="stylesheet" href="styles/flask.css" type="text/css" />
<link rel="stylesheet" href="styles/pygments.css" type="text/css">
<link rel="stylesheet" href="styles/toc2.css" type="text/css" />
<script type="text/javascript" src="js/asciidoc.js"></script>
<script type="text/javascript" src="js/flask.js"></script>
<script type="text/javascript">
/*<![CDATA[*/
asciidoc.install(2);
/*]]>*/
</script>
</head>
<body class="article">
<div id="header">
<h1>Net_Growl</h1>
<span id="author">Laurent Laville</span><br />
<span id="revnumber">version 2.7.0,</span>
<span id="revdate">2013-01-29</span>
<div id="toc">
<div id="toctitle">Table of Contents</div>
<noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
</div>
</div>
<div id="content">
<div id="preamble">
<div class="sectionbody">
<div class="sidebarblock">
<div class="content">
<div class="title">2013-01-29: Net_Growl 2.7.0 Released</div>
<div class="paragraph"><p><strong>Release highlights:</strong></p></div>
<div class="ulist"><ul>
<li>
<p>
Support Icon Collections with archive streams like ZIP or PHAR
</p>
</li>
</ul></div>
<div class="paragraph"><p>Read the <a href="CHANGELOG.html">CHANGELOG</a> for a full list of all
additions, changes and bug fixes. Changes are documented in the
updated <a href="netgrowl-book.html">User Guide</a>. See the
<a href="INSTALL.html">Installation page</a> for downloads and installation instructions.</p></div>
<div class="paragraph"><p><em>Laurent Laville</em></p></div>
</div></div>
</div>
</div>
<div class="sect1">
<h2 id="_introduction">Introduction</h2>
<div class="sectionbody">
<div class="paragraph lead"><p>Net_Growl is a PHP Library that makes it possible to easily send a notification
from your PHP script to <a href="http://growl.info">Growl</a>.</p></div>
<div class="paragraph"><p>Until now there were many UDP PHP implementations, but none for the new
<a href="http://www.growlforwindows.com/gfw/help/gntp.aspx">Growl
Notification Transport Protocol (GNTP) - v1.0</a></p></div>
<div class="paragraph"><p>I’ve decided to enlarge work begun by Bertrand Mansion with the
<a href="http://pear.php.net/package/Net_Growl">PEAR::Net_Growl</a> package (v 0.7.0).</p></div>
<div class="paragraph"><p>While you can find some old compatible PHP4 versions (0.8.0b1, 0.9.0b1, 0.9.0b2),
I’ve decided, with final stable version 2.0.0, to drop support of PHP4.</p></div>
<div class="paragraph"><p>I’m focus now on a unique PHP5 library that includes all features of GNTP 1.0</p></div>
<div class="paragraph"><p>Two different protocols may be used: the basic UDP (compatible with all platforms),
and the new one GNTP.</p></div>
<div class="paragraph"><p>The major version 2 is a full rewrites to PHP5, that used exceptions to raise
errors.</p></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<img src="./images/icons/caution.png" alt="Caution" />
</td>
<td class="content">Its recommanded to migrate to PHP5, because PHP4 version is not maintained anymore.</td>
</tr></table>
</div>
<div class="sect2">
<h3 id="_features">Features</h3>
<div class="paragraph"><p>Net_Growl provides :</p></div>
<div class="paragraph"><div class="title">Ability to use both protocol UDP and GNTP</div><p>UDP is limited to some features :</p></div>
<div class="ulist"><ul>
<li>
<p>
Application and notification icons are not provided by PHP scripts.
</p>
</li>
<li>
<p>
Callbacks are not supported.
</p>
</li>
</ul></div>
<div class="paragraph"><p>GNTP is better than UDP :</p></div>
<div class="ulist"><ul>
<li>
<p>
Application and notification icons may be provided by PHP scripts.
</p>
</li>
<li>
<p>
Callbacks may be supported. (not yet with Net_Growl beta1)
</p>
</li>
<li>
<p>
Different Hash and Encryption backend : MD5, SHA1 (for version 0.9.0b1)
plus SHA256 and SHA512 (for version 2.0.0b1)
</p>
</li>
</ul></div>
<div class="paragraph"><div class="title">Ability to log messages sent and received to Growl</div><p>Log framework used with version 0.9.0b1 is
<a href="http://pear.php.net/package/Log">PEAR::Log</a> package.
While versions since 2.0.0b1 uses no particular log framework
(basic text file I/O).</p></div>
<div class="paragraph"><div class="title">Ability to auto register before sending notification</div><p>Both versions may send notifications without to call the Net_Growl::register()
function. Net_Growl will do it for you at first notification.</p></div>
<div class="paragraph"><div class="title">Ability to display default Growl Logo</div><p>If Application and Notification icons are invalid or not reachable,
Net_Growl display the default Growl Logo.</p></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<img src="./images/icons/note.png" alt="Note" />
</td>
<td class="content">since version 2.7.0, you have ability to define the default growl icon
to use (see <code>defaultIcon</code> option), and its location (see <code>resourceDir</code> option).</td>
</tr></table>
</div>
</div>
<div class="sect2">
<h3 id="_requirements">Requirements</h3>
<div class="ulist"><div class="title">Mac OSX platform :</div><ul>
<li>
<p>
<a href="http://growl.info/">Growl</a> requires Mac OS X 10.5 or higher.
</p>
</li>
</ul></div>
<div class="ulist"><div class="title">Windows platform :</div><ul>
<li>
<p>
<a href="http://www.growlforwindows.com/gfw/">Growl for Windows</a>
is a Windows-compatible version of Growl, a notification system for Mac OS X.
</p>
</li>
</ul></div>
<div class="ulist"><div class="title">Mandatory resources :</div><ul>
<li>
<p>
<a href="http://www.php.net">PHP</a> 5.2.0 or newer
</p>
</li>
<li>
<p>
<a href="http://www.php.net/manual/en/book.pcre.php">pcre</a> extension
</p>
</li>
<li>
<p>
<a href="http://www.php.net/manual/en/book.spl.php">SPL</a> extension
</p>
</li>
<li>
<p>
<a href="http://www.php.net/manual/en/book.hash.php">hash</a> extension
requires no external libraries and is enabled by default as of PHP 5.1.2
</p>
</li>
</ul></div>
<div class="ulist"><div class="title">Optional resources :</div><ul>
<li>
<p>
<a href="http://www.php.net/manual/en/book.mcrypt.php">mcrypt</a> extension
when using GNTP adapter and encryt feature
</p>
</li>
</ul></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_documentation">Documentation</h2>
<div class="sectionbody">
<div class="paragraph lead"><p>Head to the Net_Growl <a href="netgrowl-book.html">User Guide</a> available online
for information or examples to get started.</p></div>
<div class="paragraph"><p>The Net_Growl book is available in a selection of formats.
You can download the documentation for offline reading.</p></div>
<div class="tableblock table table-bordered">
<table rules="all"
width="100%"
frame="border"
cellspacing="0" cellpadding="4">
<col width="14%" />
<col width="14%" />
<col width="14%" />
<col width="14%" />
<col width="14%" />
<col width="14%" />
<col width="14%" />
<thead>
<tr>
<th align="left" valign="top"> Language </th>
<th align="left" valign="top"> Single HTML file </th>
<th align="left" valign="top"> Many HTML files </th>
<th align="left" valign="top"> HTML Help file </th>
<th align="left" valign="top"> PDF A4 file </th>
<th align="left" valign="top"> PDF US file </th>
<th align="left" valign="top"> EPUB file</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left" valign="top"><p class="table">English</p></td>
<td align="left" valign="top"><p class="table"><a href="http://growl.laurent-laville.org/manual/current/en/netgrowl-book.html.zip">netgrowl-book.html.zip</a> 237Kb</p></td>
<td align="left" valign="top"><p class="table"><a href="http://growl.laurent-laville.org/manual/current/en/netgrowl-book.chunked.zip">netgrowl-book.chunked.zip</a> 75Kb</p></td>
<td align="left" valign="top"><p class="table"><a href="http://growl.laurent-laville.org/manual/current/en/netgrowl-book.chm.zip">netgrowl-book.chm.zip</a> 82Kb</p></td>
<td align="left" valign="top"><p class="table"><a href="http://growl.laurent-laville.org/manual/current/en/netgrowl-book-a4.pdf">netgrowl-book-a4.pdf</a> 210Kb</p></td>
<td align="left" valign="top"><p class="table"><a href="http://growl.laurent-laville.org/manual/current/en/netgrowl-book-us.pdf">netgrowl-book-us.pdf</a> 210Kb</p></td>
<td align="left" valign="top"><p class="table"><a href="http://growl.laurent-laville.org/manual/current/en/netgrowl-book.epub.zip">netgrowl-book.epub.zip</a> 66Kb</p></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_appendixes">Appendixes</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_faq">FAQ</h3>
<div class="paragraph"><p>If you are in trouble, perhaps this <a href="FAQ.html">page</a> will give you a solution.</p></div>
</div>
<div class="sect2">
<h3 id="_changelog">Changelog</h3>
<div class="paragraph"><p>You want to learn more about previous versions. Read the full <a href="CHANGELOG.html">changelog</a>.</p></div>
</div>
<div class="sect2">
<h3 id="_license">License</h3>
<div class="paragraph"><p>You are free to do whatever you want, even in a commercial environment.
You are also encouraged to contribute.
Read the full <a href="LICENSE.html">license</a>.</p></div>
</div>
<div class="sect2">
<h3 id="_credits">Credits</h3>
<div class="paragraph"><p>I would like to thanks here specially two guys without who this PHP version
won’t be born.</p></div>
<div class="quoteblock">
<div class="content">
<div class="paragraph"><p>Original author of <a href="http://pear.php.net/package/Net_Growl">PEAR::Net_Growl</a>,
that gave me hope to use one day the package on Windows platform.</p></div>
</div>
<div class="attribution">
<em>http://www.mamasam.com/</em><br />
— Bertrand Mansion
</div></div>
<div class="quoteblock">
<div class="content">
<div class="paragraph"><p>Author of Growl for Windows, that make the dream a reality for all Windows users.
He also help me a lot to finalize the authorization part and encryption messages.</p></div>
</div>
<div class="attribution">
<em>http://www.growlforwindows.com/gfw/</em><br />
— Brian Dunnington
</div></div>
<div class="paragraph"><p>And of course, a special thanks to</p></div>
<div class="quoteblock">
<div class="content">
<div class="paragraph"><p>Growl Team without who, this adventure wouldn’t be true.</p></div>
</div>
<div class="attribution">
<em>http://growl.info/</em><br />
— Growl Team
</div></div>
</div>
<div class="sect2">
<h3 id="_links">Links</h3>
<div class="paragraph"><p>All pages of this site, and user guide were generated with AsciiDoc 8.6.8,
assisted by FOP 1.0 (for PDFs). Automated build process uses Phing 2.4.14</p></div>
<div class="paragraph"><p>Convert the HTML Help source (.hhp and .html) files to HTML Help (.chm) files
using the Microsoft HTML Help Compiler.</p></div>
<div class="ulist"><ul>
<li>
<p>
<a href="http://www.methods.co.nz/asciidoc/index.html">AsciiDoc</a>
</p>
</li>
<li>
<p>
<a href="http://pygments.org/">Pygments - Python syntax highlighter</a>
</p>
</li>
<li>
<p>
<a href="http://xmlgraphics.apache.org/fop/">Apache FOP</a>
</p>
</li>
<li>
<p>
<a href="http://msdn.microsoft.com/en-us/library/ms670169%28VS.85%29.aspx">Microsoft HTML Help Compiler</a>
</p>
</li>
<li>
<p>
<a href="http://phing.info/trac/">Phing</a>
</p>
</li>
</ul></div>
</div>
</div>
</div>
</div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Version 2.7.0<br />
Last updated 2013-01-29 17:13:44 Paris, Madrid
</div>
</div>
</body>
</html>