| Current File : //opt/RZphp73/includes/doc/Net_Growl/html/FAQ.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="Frequently Asked Questions" />
<meta name="keywords" content="PEAR, Network, Notification, Growl" />
<title>FAQ</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>FAQ</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="paragraph lead"><p>If you are in trouble, perhaps this page will give you a solution.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_troubleshooting">Troubleshooting</h2>
<div class="sectionbody">
<div class="qlist qanda"><ol>
<li>
<p><em>
<strong>The response times are slow</strong>
</em></p>
<p>
You can reduced timeout period on a stream (socket) to connect/read.
Default is 30 secondes, like <em>php.ini</em> <code>default_socket_timeout</code> directive.<br />
</p>
<div class="exampleblock" id="EXFAQ1">
<div class="title">Example 1. Set timetout to 15 secondes</div>
<div class="content">
<div class="listingblock">
<div class="content"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="k">require_once</span> <span class="s1">'Net/Growl/Autoload.php'</span><span class="p">;</span>
<span class="nv">$notifications</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span>
<span class="s1">'GROWL_NOTIFY_PHPERROR'</span>
<span class="p">);</span>
<span class="nv">$appName</span> <span class="o">=</span> <span class="s1">'PHP App Example using GNTP'</span><span class="p">;</span>
<span class="nv">$password</span> <span class="o">=</span> <span class="s1">''</span><span class="p">;</span>
<span class="nv">$app</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Net_Growl_Application</span><span class="p">(</span>
<span class="nv">$appName</span><span class="p">,</span>
<span class="nv">$notifications</span><span class="p">,</span>
<span class="nv">$password</span>
<span class="p">);</span>
<span class="nv">$options</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span>
<span class="s1">'protocol'</span> <span class="o">=></span> <span class="s1">'gntp'</span><span class="p">,</span>
<span class="s1">'timeout'</span> <span class="o">=></span> <span class="mi">15</span>
<span class="p">);</span>
<span class="nv">$growl</span> <span class="o">=</span> <span class="nx">Net_Growl</span><span class="o">::</span><span class="na">singleton</span><span class="p">(</span><span class="nv">$app</span><span class="p">,</span> <span class="k">null</span><span class="p">,</span> <span class="k">null</span><span class="p">,</span> <span class="nv">$options</span><span class="p">);</span>
<span class="nv">$growl</span><span class="o">-></span><span class="na">register</span><span class="p">();</span>
<span class="cp">?></span><span class="x"></span>
</pre></div></div></div>
</div></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<img src="./images/icons/tip.png" alt="Tip" />
</td>
<td class="content">You can also suppress timeout by setting value to zero.</td>
</tr></table>
</div>
</li>
<li>
<p><em>
<strong>Notifications are not displayed</strong>
</em></p>
<div class="ulist"><ul>
<li>
<p>
Are you sure Growl is running (not stopped or paused) ?
</p>
</li>
<li>
<p>
Check if your application and the notification type used is well registered
</p>
</li>
<li>
<p>
If your application is well registered, check if notifications display are enabled
</p>
</li>
<li>
<p>
Password provided by your application is probably unknown of Growl client
(see Password Manager on Security Tab)
</p>
</li>
<li>
<p>
Check if your code produces error/exceptions.
</p>
<div class="exampleblock" id="EXFAQ2">
<div class="title">Example 2. Catch errors with a try catch</div>
<div class="content">
<div class="listingblock">
<div class="content"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="k">require_once</span> <span class="s1">'Net/Growl/Autoload.php'</span><span class="p">;</span>
<span class="nv">$notifications</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span>
<span class="s1">'GROWL_NOTIFY_PHPERROR'</span>
<span class="p">);</span>
<span class="nv">$appName</span> <span class="o">=</span> <span class="s1">'PHP App Example using GNTP'</span><span class="p">;</span>
<span class="nv">$password</span> <span class="o">=</span> <span class="s1">''</span><span class="p">;</span>
<span class="nv">$options</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span>
<span class="s1">'protocol'</span> <span class="o">=></span> <span class="s1">'gntp'</span><span class="p">,</span>
<span class="p">);</span>
<span class="k">try</span> <span class="p">{</span>
<span class="nv">$growl</span> <span class="o">=</span> <span class="nx">Net_Growl</span><span class="o">::</span><span class="na">singleton</span><span class="p">(</span><span class="nv">$appName</span><span class="p">,</span> <span class="nv">$notifications</span><span class="p">,</span> <span class="nv">$password</span><span class="p">,</span> <span class="nv">$options</span><span class="p">);</span>
<span class="nv">$growl</span><span class="o">-></span><span class="na">register</span><span class="p">();</span>
<span class="p">}</span> <span class="k">catch</span> <span class="p">(</span><span class="nx">Net_Growl_Exception</span> <span class="nv">$e</span><span class="p">)</span> <span class="p">{</span>
<span class="k">echo</span> <span class="s1">'Caught Growl exception: '</span> <span class="o">.</span> <span class="nv">$e</span><span class="o">-></span><span class="na">getMessage</span><span class="p">()</span> <span class="o">.</span> <span class="nx">PHP_EOL</span><span class="p">;</span>
<span class="p">}</span>
<span class="cp">?></span><span class="x"></span>
</pre></div></div></div>
</div></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<img src="./images/icons/important.png" alt="Important" />
</td>
<td class="content">All errors produced by Net_Growl raise a <a href="#C3">Net_Growl_Exception</a></td>
</tr></table>
</div>
</li>
</ul></div>
</li>
<li>
<p><em>
<strong>Net_Growl is not really verbose</strong>
</em></p>
<p>
To known what MIME messages are sent and received from Growl, activate
the <code>verbose</code> mode. Give a valid path to a filename on <code>debug</code> option.
</p>
<div class="exampleblock" id="EXFAQ3">
<div class="title">Example 3. Activate the debug mode</div>
<div class="content">
<div class="listingblock">
<div class="content"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="k">require_once</span> <span class="s1">'Net/Growl/Autoload.php'</span><span class="p">;</span>
<span class="nv">$notifications</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span>
<span class="s1">'GROWL_NOTIFY_PHPERROR'</span>
<span class="p">);</span>
<span class="nv">$appName</span> <span class="o">=</span> <span class="s1">'PHP App Example using GNTP'</span><span class="p">;</span>
<span class="nv">$password</span> <span class="o">=</span> <span class="s1">''</span><span class="p">;</span>
<span class="nv">$options</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span>
<span class="s1">'protocol'</span> <span class="o">=></span> <span class="s1">'gntp'</span><span class="p">,</span>
<span class="s1">'debug'</span> <span class="o">=></span> <span class="nb">dirname</span><span class="p">(</span><span class="k">__FILE__</span><span class="p">)</span> <span class="o">.</span> <span class="nx">DIRECTORY_SEPARATOR</span> <span class="o">.</span> <span class="s1">'netgrowl.log'</span>
<span class="p">);</span>
<span class="k">try</span> <span class="p">{</span>
<span class="nv">$growl</span> <span class="o">=</span> <span class="nx">Net_Growl</span><span class="o">::</span><span class="na">singleton</span><span class="p">(</span><span class="nv">$appName</span><span class="p">,</span> <span class="nv">$notifications</span><span class="p">,</span> <span class="nv">$password</span><span class="p">,</span> <span class="nv">$options</span><span class="p">);</span>
<span class="nv">$growl</span><span class="o">-></span><span class="na">register</span><span class="p">();</span>
<span class="p">}</span> <span class="k">catch</span> <span class="p">(</span><span class="nx">Net_Growl_Exception</span> <span class="nv">$e</span><span class="p">)</span> <span class="p">{</span>
<span class="k">echo</span> <span class="s1">'Caught Growl exception: '</span> <span class="o">.</span> <span class="nv">$e</span><span class="o">-></span><span class="na">getMessage</span><span class="p">()</span> <span class="o">.</span> <span class="nx">PHP_EOL</span><span class="p">;</span>
<span class="p">}</span>
<span class="cp">?></span><span class="x"></span>
</pre></div></div></div>
</div></div>
</li>
<li>
<p><em>
<strong>My favorite application icons are not shown</strong>
</em></p>
<div class="ulist"><ul>
<li>
<p>
URL given are not valid or not reachable
</p>
</li>
<li>
<p>
URL are good but resources are invalid images
</p>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<img src="./images/icons/note.png" alt="Note" />
</td>
<td class="content">If you give URL/resource that are not valid, Net_Growl will use default icon
returns by <a href="#C1M6">Net_Growl::getDefaultGrowlIcon</a> method.</td>
</tr></table>
</div>
</li>
</ul></div>
</li>
<li>
<p><em>
<strong>How to detect error with new version 2.1</strong>
</em></p>
<p>
GNTP specialized response are now returned with version 2.1.0 (or greater).
If you want to catch an error, test status code after each register() or notify() method.
See <a href="#C7M4">Net_Growl_Response::getStatus</a>
</p>
<div class="exampleblock" id="EXFAQ4">
<div class="title">Example 4. Use the Net_Growl_Response object</div>
<div class="content">
<div class="listingblock">
<div class="content"><div class="highlight"><pre><span class="cp"><?php</span>
<span class="k">require_once</span> <span class="s1">'Net/Growl/Autoload.php'</span><span class="p">;</span>
<span class="nv">$notifications</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span>
<span class="s1">'GROWL_NOTIFY_PHPERROR'</span>
<span class="p">);</span>
<span class="nv">$appName</span> <span class="o">=</span> <span class="s1">'PHP App Example using GNTP'</span><span class="p">;</span>
<span class="nv">$password</span> <span class="o">=</span> <span class="s1">''</span><span class="p">;</span>
<span class="nv">$options</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span>
<span class="s1">'protocol'</span> <span class="o">=></span> <span class="s1">'gntp'</span><span class="p">,</span>
<span class="s1">'debug'</span> <span class="o">=></span> <span class="nb">dirname</span><span class="p">(</span><span class="k">__FILE__</span><span class="p">)</span> <span class="o">.</span> <span class="nx">DIRECTORY_SEPARATOR</span> <span class="o">.</span> <span class="s1">'netgrowl.log'</span>
<span class="p">);</span>
<span class="k">try</span> <span class="p">{</span>
<span class="nv">$growl</span> <span class="o">=</span> <span class="nx">Net_Growl</span><span class="o">::</span><span class="na">singleton</span><span class="p">(</span><span class="nv">$appName</span><span class="p">,</span> <span class="nv">$notifications</span><span class="p">,</span> <span class="nv">$password</span><span class="p">,</span> <span class="nv">$options</span><span class="p">);</span>
<span class="nv">$resp</span> <span class="o">=</span> <span class="nv">$growl</span><span class="o">-></span><span class="na">register</span><span class="p">();</span>
<span class="k">if</span> <span class="p">(</span><span class="nv">$resp</span><span class="o">-></span><span class="na">getStatus</span><span class="p">()</span> <span class="o">!=</span> <span class="s1">'OK'</span><span class="p">)</span> <span class="p">{</span>
<span class="k">die</span><span class="p">(</span><span class="nv">$resp</span><span class="p">);</span>
<span class="p">}</span>
<span class="p">}</span> <span class="k">catch</span> <span class="p">(</span><span class="nx">Net_Growl_Exception</span> <span class="nv">$e</span><span class="p">)</span> <span class="p">{</span>
<span class="k">echo</span> <span class="s1">'Caught Growl exception: '</span> <span class="o">.</span> <span class="nv">$e</span><span class="o">-></span><span class="na">getMessage</span><span class="p">()</span> <span class="o">.</span> <span class="nx">PHP_EOL</span><span class="p">;</span>
<span class="p">}</span>
<span class="cp">?></span><span class="x"></span>
</pre></div></div></div>
</div></div>
</li>
</ol></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-22 17:40:18 Paris, Madrid
</div>
</div>
</body>
</html>