<?xml version="1.0" encoding="iso-8859-1"?> <!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" xml:lang="en" lang="en"> <head> <title>Class: Log</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> <meta http-equiv="Content-Script-Type" content="text/javascript" /> <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" /> <script type="text/javascript"> // <![CDATA[ function popupCode( url ) { window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400") } function toggleCode( id ) { if ( document.getElementById ) elem = document.getElementById( id ); else if ( document.all ) elem = eval( "document.all." + id ); else return false; elemStyle = elem.style; if ( elemStyle.display != "block" ) { elemStyle.display = "block" } else { elemStyle.display = "none" } return true; } // Make codeblocks hidden by default document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" ) // ]]> </script> </head> <body> <div id="classHeader"> <table class="header-table"> <tr class="top-aligned-row"> <td><strong>Class</strong></td> <td class="class-name-in-header">Log</td> </tr> <tr class="top-aligned-row"> <td><strong>In:</strong></td> <td> <a href="../files/lib/utility/log_rb.html"> lib/utility/log.rb </a> <br /> </td> </tr> <tr class="top-aligned-row"> <td><strong>Parent:</strong></td> <td> Object </td> </tr> </table> </div> <!-- banner header --> <div id="bodyContent"> <div id="contextContent"> <div id="diagram"> <map id="map" name="map"> <area shape="rect" coords="5,5,77,53" href="Module.html" alt="Module " /> <area shape="rect" coords="149,101,221,149" href="Log.html" alt="Log " /> <area shape="rect" coords="101,5,173,53" href="Singleton.html" alt="Singleton " /> <area shape="rect" coords="197,5,269,53" href="Log4r.html" alt="Log4r " /> </map> <img src="../dot/f_56.png" usemap="#map" border="0" alt="dot/f_56.png"> </div> <div id="description"> <p> The <a href="Log.html">Log</a> class is a singleton that handles logging at the class level </p> </div> </div> <div id="method-list"> <h3 class="section-bar">Methods</h3> <div class="name-list"> <a href="#M000103">loginit</a> <a href="#M000102">new</a> </div> </div> </div> <!-- if includes --> <div id="includes"> <h3 class="section-bar">Included Modules</h3> <div id="includes-list"> <span class="include-name">Singleton</span> <span class="include-name">Log4r</span> </div> </div> <div id="section"> <!-- if method_list --> <div id="methods"> <h3 class="section-bar">Public Class methods</h3> <div id="method-M000102" class="method-detail"> <a name="M000102"></a> <div class="method-heading"> <a href="#M000102" class="method-signature"> <span class="method-name">new</span><span class="method-args">()</span> </a> </div> <div class="method-description"> <p> Load logger configuration </p> <p><a class="source-toggle" href="#" onclick="toggleCode('M000102-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000102-source"> <pre> <span class="ruby-comment cmt"># File lib/utility/log.rb, line 28</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span> <span class="ruby-constant">Logger</span>[<span class="ruby-value str">'global'</span>].<span class="ruby-identifier">level</span> = <span class="ruby-constant">DEBUG</span> <span class="ruby-identifier">fmt</span> = <span class="ruby-constant">PatternFormatter</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">:pattern</span> =<span class="ruby-operator">></span> <span class="ruby-value str">"%d [%5l] (%c) %M"</span>, <span class="ruby-identifier">:date_pattern</span> =<span class="ruby-operator">></span> <span class="ruby-value str">"%y-%m-%d %H:%M:%S"</span>) <span class="ruby-constant">StderrOutputter</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'stderr'</span>, <span class="ruby-identifier">:level</span> =<span class="ruby-operator">></span> <span class="ruby-constant">INFO</span>, <span class="ruby-identifier">:formatter</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">fmt</span>) <span class="ruby-constant">FileOutputter</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'server'</span>, <span class="ruby-identifier">:level</span> =<span class="ruby-operator">></span> <span class="ruby-constant">DEBUG</span>, <span class="ruby-identifier">:formatter</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">fmt</span>, <span class="ruby-identifier">:filename</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">options</span>[<span class="ruby-value str">'logfile'</span>] <span class="ruby-operator">||</span> <span class="ruby-value str">'logs/server.log'</span> , <span class="ruby-identifier">:trunc</span> =<span class="ruby-operator">></span> <span class="ruby-value str">'false'</span>) <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <h3 class="section-bar">Public Instance methods</h3> <div id="method-M000103" class="method-detail"> <a name="M000103"></a> <div class="method-heading"> <a href="#M000103" class="method-signature"> <span class="method-name">loginit</span><span class="method-args">(logname, loglevel, logto)</span> </a> </div> <div class="method-description"> <p> Access a logger class </p> <dl> <dt><tt>logname</tt></dt><dd>The name of the logger </dd> <dt><tt>loglevel</tt></dt><dd>the level of logging to do </dd> </dl> <p><a class="source-toggle" href="#" onclick="toggleCode('M000103-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000103-source"> <pre> <span class="ruby-comment cmt"># File lib/utility/log.rb, line 41</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">loginit</span>(<span class="ruby-identifier">logname</span>, <span class="ruby-identifier">loglevel</span>, <span class="ruby-identifier">logto</span>) <span class="ruby-constant">Logger</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">logname</span>, <span class="ruby-constant">Log4r</span>.<span class="ruby-identifier">const_get</span>(<span class="ruby-identifier">loglevel</span>)).<span class="ruby-identifier">outputters</span> = <span class="ruby-identifier">logto</span> <span class="ruby-constant">Logger</span>[<span class="ruby-identifier">logname</span>] <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> </div> </div> <div id="validator-badges"> <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p> </div> </body> </html>