<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <title>Recipe Fiddle: com\whitemagicsoftware\Logger Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css" /> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </script> </head> <body> <div id="top"><!-- do not remove this div! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">Recipe Fiddle </div> </td> </tr> </tbody> </table> </div> <!-- Generated by Doxygen 1.7.6.1 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Variables</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><b>com</b> </li> <li class="navelem"><b>whitemagicsoftware</b> </li> <li class="navelem"><a class="el" href="classcom_1_1whitemagicsoftware_1_1Logger.html">Logger</a> </li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#pub-static-methods">Static Public Member Functions</a> </div> <div class="headertitle"> <div class="title">com\whitemagicsoftware\Logger Class Reference</div> </div> </div><!--header--> <div class="contents"> <!-- doxytag: class="com::whitemagicsoftware::Logger" --> <p>Responsible for sending e-mail notifications whenever an error happens with the system. <a href="classcom_1_1whitemagicsoftware_1_1Logger.html#details">More...</a></p> <p><a href="classcom_1_1whitemagicsoftware_1_1Logger-members.html">List of all members.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="pub-static-methods"></a> Static Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac9ece369c30c67b3bf56766e94e9bc0c"></a><!-- doxytag: member="com::whitemagicsoftware::Logger::init" ref="ac9ece369c30c67b3bf56766e94e9bc0c" args="()" --> static </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1whitemagicsoftware_1_1Logger.html#ac9ece369c30c67b3bf56766e94e9bc0c">init</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Configures PHP settings for error handling. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1whitemagicsoftware_1_1Logger.html#a1d72e8dd7b66de11b833f0bcc43b352c">error</a> ($message, $errfile, $errline)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Formats and sends an e-mail about the given error. <a href="#a1d72e8dd7b66de11b833f0bcc43b352c"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1whitemagicsoftware_1_1Logger.html#aed77fbc1986b673478f025d9861f0f72">log</a> ($message)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Logs a message to PHP's error_log. <a href="#aed77fbc1986b673478f025d9861f0f72"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1whitemagicsoftware_1_1Logger.html#aad133340ddf8ae5675be6d0f78e892bc">handle</a> ($errno, $errstr, $errfile, $errline)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Formats and sends an e-mail about the given error. <a href="#aad133340ddf8ae5675be6d0f78e892bc"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1whitemagicsoftware_1_1Logger.html#a5e6c4047cbf73e8b3f8ea70a94900618">format</a> ($errno, $errstr, $errfile, $errline)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Formats the error message into an HTML table before sending an HTML-based e-mail. <a href="#a5e6c4047cbf73e8b3f8ea70a94900618"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a85608fe9176efd14167b88f800adabff"></a><!-- doxytag: member="com::whitemagicsoftware::Logger::mail" ref="a85608fe9176efd14167b88f800adabff" args="($content, $redirect=true)" --> static </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1whitemagicsoftware_1_1Logger.html#a85608fe9176efd14167b88f800adabff">mail</a> ($content, $redirect=true)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Sends an e-mail to $DEFAULT_EMAIL_TO whenever an error occurs. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a07ee5c0a004416fc724f8a9989ab1112"></a><!-- doxytag: member="com::whitemagicsoftware::Logger::curl" ref="a07ee5c0a004416fc724f8a9989ab1112" args="($errline, $curl)" --> static </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1whitemagicsoftware_1_1Logger.html#a07ee5c0a004416fc724f8a9989ab1112">curl</a> ($errline, $<a class="el" href="classcom_1_1whitemagicsoftware_1_1Logger.html#a07ee5c0a004416fc724f8a9989ab1112">curl</a>)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Sends a notification if there was an error connecting to the NLP. <br/></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>Responsible for sending e-mail notifications whenever an error happens with the system. </p> </div><hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a1d72e8dd7b66de11b833f0bcc43b352c"></a><!-- doxytag: member="com::whitemagicsoftware::Logger::error" ref="a1d72e8dd7b66de11b833f0bcc43b352c" args="($message, $errfile, $errline)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1Logger.html#a1d72e8dd7b66de11b833f0bcc43b352c">Logger::error</a> </td> <td>(</td> <td class="paramtype">$ </td> <td class="paramname"><em>message</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">$ </td> <td class="paramname"><em>errfile</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">$ </td> <td class="paramname"><em>errline</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Formats and sends an e-mail about the given error. </p> <p>This also logs the error to the PHP log file.</p> <dl class="params"><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">$message</td><td>The error message. </td></tr> <tr><td class="paramname">$errfile</td><td>The file where the error happened. </td></tr> <tr><td class="paramname">$errline</td><td>The line number in the file that triggered the problem. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a5e6c4047cbf73e8b3f8ea70a94900618"></a><!-- doxytag: member="com::whitemagicsoftware::Logger::format" ref="a5e6c4047cbf73e8b3f8ea70a94900618" args="($errno, $errstr, $errfile, $errline)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1Logger.html#a5e6c4047cbf73e8b3f8ea70a94900618">Logger::format</a> </td> <td>(</td> <td class="paramtype">$ </td> <td class="paramname"><em>errno</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">$ </td> <td class="paramname"><em>errstr</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">$ </td> <td class="paramname"><em>errfile</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">$ </td> <td class="paramname"><em>errline</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Formats the error message into an HTML table before sending an HTML-based e-mail. </p> <dl class="params"><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">$errno</td><td>The error number. </td></tr> <tr><td class="paramname">$errstr</td><td>The error message. </td></tr> <tr><td class="paramname">$errfile</td><td>The file where the error happened. </td></tr> <tr><td class="paramname">$errline</td><td>The line number in the file that triggered the problem. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="aad133340ddf8ae5675be6d0f78e892bc"></a><!-- doxytag: member="com::whitemagicsoftware::Logger::handle" ref="aad133340ddf8ae5675be6d0f78e892bc" args="($errno, $errstr, $errfile, $errline)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1Logger.html#aad133340ddf8ae5675be6d0f78e892bc">Logger::handle</a> </td> <td>(</td> <td class="paramtype">$ </td> <td class="paramname"><em>errno</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">$ </td> <td class="paramname"><em>errstr</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">$ </td> <td class="paramname"><em>errfile</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">$ </td> <td class="paramname"><em>errline</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Formats and sends an e-mail about the given error. </p> <dl class="params"><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">$errno</td><td>The error number. </td></tr> <tr><td class="paramname">$errstr</td><td>The error message. </td></tr> <tr><td class="paramname">$errfile</td><td>The file where the error happened. </td></tr> <tr><td class="paramname">$errline</td><td>The line number in the file that triggered the problem. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="aed77fbc1986b673478f025d9861f0f72"></a><!-- doxytag: member="com::whitemagicsoftware::Logger::log" ref="aed77fbc1986b673478f025d9861f0f72" args="($message)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1Logger.html#aed77fbc1986b673478f025d9861f0f72">Logger::log</a> </td> <td>(</td> <td class="paramtype">$ </td> <td class="paramname"><em>message</em></td><td>)</td> <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Logs a message to PHP's error_log. </p> <dl class="params"><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">$message</td><td>The content of the error message. </td></tr> </table> </dd> </dl> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li>class.Logger.php</li> </ul> </div><!-- contents --> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Variables</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <hr class="footer"/><address class="footer"><small> Generated on Tue Jul 30 2013 22:06:29 for Recipe Fiddle by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.7.6.1 </small></address> </body> </html>