| <?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"> |
| <head> |
| <!-- template designed by Marco Von Ballmoos --> |
| <title>Docs For Class LoggerLayout</title> |
| <link rel="stylesheet" href="../media/stylesheet.css" /> |
| <script src="../media/lib/classTree.js"></script> |
| <script language="javascript" type="text/javascript"> |
| var imgPlus = new Image(); |
| var imgMinus = new Image(); |
| imgPlus.src = "../media/images/plus.png"; |
| imgMinus.src = "../media/images/minus.png"; |
| |
| function showNode(Node){ |
| switch(navigator.family){ |
| case 'nn4': |
| // Nav 4.x code fork... |
| var oTable = document.layers["span" + Node]; |
| var oImg = document.layers["img" + Node]; |
| break; |
| case 'ie4': |
| // IE 4/5 code fork... |
| var oTable = document.all["span" + Node]; |
| var oImg = document.all["img" + Node]; |
| break; |
| case 'gecko': |
| // Standards Compliant code fork... |
| var oTable = document.getElementById("span" + Node); |
| var oImg = document.getElementById("img" + Node); |
| break; |
| } |
| oImg.src = imgMinus.src; |
| oTable.style.display = "block"; |
| } |
| |
| function hideNode(Node){ |
| switch(navigator.family){ |
| case 'nn4': |
| // Nav 4.x code fork... |
| var oTable = document.layers["span" + Node]; |
| var oImg = document.layers["img" + Node]; |
| break; |
| case 'ie4': |
| // IE 4/5 code fork... |
| var oTable = document.all["span" + Node]; |
| var oImg = document.all["img" + Node]; |
| break; |
| case 'gecko': |
| // Standards Compliant code fork... |
| var oTable = document.getElementById("span" + Node); |
| var oImg = document.getElementById("img" + Node); |
| break; |
| } |
| oImg.src = imgPlus.src; |
| oTable.style.display = "none"; |
| } |
| |
| function nodeIsVisible(Node){ |
| switch(navigator.family){ |
| case 'nn4': |
| // Nav 4.x code fork... |
| var oTable = document.layers["span" + Node]; |
| break; |
| case 'ie4': |
| // IE 4/5 code fork... |
| var oTable = document.all["span" + Node]; |
| break; |
| case 'gecko': |
| // Standards Compliant code fork... |
| var oTable = document.getElementById("span" + Node); |
| break; |
| } |
| return (oTable && oTable.style.display == "block"); |
| } |
| |
| function toggleNodeVisibility(Node){ |
| if (nodeIsVisible(Node)){ |
| hideNode(Node); |
| }else{ |
| showNode(Node); |
| } |
| } |
| </script> |
| </head> |
| <body> |
| <div class="page-body"> |
| <h2 class="class-name">Class LoggerLayout</h2> |
| |
| <a name="sec-description"></a> |
| <div class="info-box"> |
| <div class="info-box-title">Description</div> |
| <div class="nav-bar"> |
| <span class="disabled">Description</span> | |
| <a href="#sec-descendents">Descendents</a> |
| | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| |
| </div> |
| <div class="info-box-body"> |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">Extend this abstract class to create your own log layout format.</p> |
| <ul class="tags"> |
| <li><span class="field">version:</span> $Revision: 1213283 $</li> |
| <li><span class="field">abstract:</span> </li> |
| </ul> |
| <p class="notes"> |
| Located in <a class="field" href="_LoggerLayout.php.html">/LoggerLayout.php</a> (line <span class="field">27</span>) |
| </p> |
| |
| |
| <pre><a href="../log4php/LoggerConfigurable.html">LoggerConfigurable</a> |
| | |
| --LoggerLayout</pre> |
| |
| </div> |
| </div> |
| |
| <a name="sec-descendents"></a> |
| <div class="info-box"> |
| <div class="info-box-title">Direct descendents</div> |
| <div class="nav-bar"> |
| <a href="#sec-description">Description</a> | |
| <span class="disabled">Descendents</span> |
| | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| |
| </div> |
| <div class="info-box-body"> |
| <table cellpadding="2" cellspacing="0" class="class-table"> |
| <tr> |
| <th class="class-table-header">Class</th> |
| <th class="class-table-header">Description</th> |
| </tr> |
| <tr> |
| <td style="padding-right: 2em"><a href="../log4php/layouts/LoggerLayoutXml.html">LoggerLayoutXml</a></td> |
| <td> |
| The output of the LoggerXmlLayout consists of a series of log4php:event elements. |
| </td> |
| </tr> |
| <tr> |
| <td style="padding-right: 2em"><a href="../log4php/layouts/LoggerLayoutTTCC.html">LoggerLayoutTTCC</a></td> |
| <td> |
| TTCC layout format consists of <strong>t</strong>ime, <strong>t</strong>hread, <strong>c</strong>ategory and nested diagnostic <strong>c</strong>ontext information, hence the name. |
| </td> |
| </tr> |
| <tr> |
| <td style="padding-right: 2em"><a href="../log4php/layouts/LoggerLayoutSimple.html">LoggerLayoutSimple</a></td> |
| <td> |
| A simple layout. |
| </td> |
| </tr> |
| <tr> |
| <td style="padding-right: 2em"><a href="../log4php/layouts/LoggerLayoutHtml.html">LoggerLayoutHtml</a></td> |
| <td> |
| This layout outputs events in a HTML table. |
| </td> |
| </tr> |
| <tr> |
| <td style="padding-right: 2em"><a href="../log4php/layouts/LoggerLayoutPattern.html">LoggerLayoutPattern</a></td> |
| <td> |
| A flexible layout configurable with pattern string. |
| </td> |
| </tr> |
| <tr> |
| <td style="padding-right: 2em"><a href="../log4php/layouts/LoggerLayoutSerialized.html">LoggerLayoutSerialized</a></td> |
| <td> |
| Layout which formats the events using PHP's serialize() function. |
| </td> |
| </tr> |
| </table> |
| </div> |
| </div> |
| |
| |
| |
| <a name="sec-method-summary"></a> |
| <div class="info-box"> |
| <div class="info-box-title">Method Summary</span></div> |
| <div class="nav-bar"> |
| <a href="#sec-description">Description</a> | |
| <a href="#sec-descendents">Descendents</a> | |
| <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
| </div> |
| <div class="info-box-body"> |
| <div class="method-summary"> |
| |
| <div class="method-definition"> |
| <span class="method-result">void</span> |
| <a href="#activateOptions" title="details" class="method-name">activateOptions</a> |
| () |
| </div> |
| |
| <div class="method-definition"> |
| <span class="method-result">string</span> |
| <a href="#format" title="details" class="method-name">format</a> |
| (<span class="var-type"><a href="../log4php/LoggerLoggingEvent.html">LoggerLoggingEvent</a></span> <span class="var-name">$event</span>) |
| </div> |
| |
| <div class="method-definition"> |
| <span class="method-result">string</span> |
| <a href="#getContentType" title="details" class="method-name">getContentType</a> |
| () |
| </div> |
| |
| <div class="method-definition"> |
| <span class="method-result">string</span> |
| <a href="#getFooter" title="details" class="method-name">getFooter</a> |
| () |
| </div> |
| |
| <div class="method-definition"> |
| <span class="method-result">string</span> |
| <a href="#getHeader" title="details" class="method-name">getHeader</a> |
| () |
| </div> |
| |
| <div class="method-definition"> |
| <span class="method-result">void</span> |
| <a href="#warn" title="details" class="method-name">warn</a> |
| (<span class="var-type"></span> <span class="var-name">$message</span>) |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| |
| <a name="sec-methods"></a> |
| <div class="info-box"> |
| <div class="info-box-title">Methods</div> |
| <div class="nav-bar"> |
| <a href="#sec-description">Description</a> | |
| <a href="#sec-descendents">Descendents</a> | |
| <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
| |
| </div> |
| <div class="info-box-body"> |
| <A NAME='method_detail'></A> |
| <a name="methodactivateOptions" id="activateOptions"><!-- --></a> |
| <div class="oddrow"> |
| |
| <div class="method-header"> |
| <span class="method-title">activateOptions</span> (line <span class="line-number">32</span>) |
| </div> |
| |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">Activates options for this layout.</p> |
| <p class="description"><p>Override this method if you have options to be activated.</p></p> |
| <ul class="tags"> |
| <li><span class="field">access:</span> public</li> |
| </ul> |
| |
| <div class="method-signature"> |
| <span class="method-result">void</span> |
| <span class="method-name"> |
| activateOptions |
| </span> |
| () |
| </div> |
| |
| |
| |
| <hr class="separator" /> |
| <div class="notes">Redefined in descendants as:</div> |
| <ul class="redefinitions"> |
| <li> |
| <a href="../log4php/layouts/LoggerLayoutXml.html#methodactivateOptions">LoggerLayoutXml::activateOptions()</a> |
| </li> |
| </ul> |
| </div> |
| <a name="methodformat" id="format"><!-- --></a> |
| <div class="evenrow"> |
| |
| <div class="method-header"> |
| <span class="method-title">format</span> (line <span class="line-number">42</span>) |
| </div> |
| |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">Override this method to create your own layout format.</p> |
| <ul class="tags"> |
| <li><span class="field">access:</span> public</li> |
| </ul> |
| |
| <div class="method-signature"> |
| <span class="method-result">string</span> |
| <span class="method-name"> |
| format |
| </span> |
| (<span class="var-type"><a href="../log4php/LoggerLoggingEvent.html">LoggerLoggingEvent</a></span> <span class="var-name">$event</span>) |
| </div> |
| |
| <ul class="parameters"> |
| <li> |
| <span class="var-type"><a href="../log4php/LoggerLoggingEvent.html">LoggerLoggingEvent</a></span> |
| <span class="var-name">$event</span> </li> |
| </ul> |
| |
| |
| <hr class="separator" /> |
| <div class="notes">Redefined in descendants as:</div> |
| <ul class="redefinitions"> |
| <li> |
| <a href="../log4php/layouts/LoggerLayoutXml.html#methodformat">LoggerLayoutXml::format()</a> |
| : Formats a <a href="../log4php/LoggerLoggingEvent.html">LoggerLoggingEvent</a> in conformance with the log4php.dtd. |
| </li> |
| <li> |
| <a href="../log4php/layouts/LoggerLayoutTTCC.html#methodformat">LoggerLayoutTTCC::format()</a> |
| : In addition to the level of the statement and message, the returned string includes time, thread, category. |
| </li> |
| <li> |
| <a href="../log4php/layouts/LoggerLayoutSimple.html#methodformat">LoggerLayoutSimple::format()</a> |
| : Returns the log statement in a format consisting of the |
| </li> |
| <li> |
| <a href="../log4php/layouts/LoggerLayoutHtml.html#methodformat">LoggerLayoutHtml::format()</a> |
| </li> |
| <li> |
| <a href="../log4php/layouts/LoggerLayoutPattern.html#methodformat">LoggerLayoutPattern::format()</a> |
| : Produces a formatted string as specified by the conversion pattern. |
| </li> |
| <li> |
| <a href="../log4php/layouts/LoggerLayoutSerialized.html#methodformat">LoggerLayoutSerialized::format()</a> |
| </li> |
| </ul> |
| </div> |
| <a name="methodgetContentType" id="getContentType"><!-- --></a> |
| <div class="oddrow"> |
| |
| <div class="method-header"> |
| <span class="method-title">getContentType</span> (line <span class="line-number">50</span>) |
| </div> |
| |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">Returns the content type output by this layout.</p> |
| <ul class="tags"> |
| <li><span class="field">access:</span> public</li> |
| </ul> |
| |
| <div class="method-signature"> |
| <span class="method-result">string</span> |
| <span class="method-name"> |
| getContentType |
| </span> |
| () |
| </div> |
| |
| |
| |
| <hr class="separator" /> |
| <div class="notes">Redefined in descendants as:</div> |
| <ul class="redefinitions"> |
| <li> |
| <a href="../log4php/layouts/LoggerLayoutHtml.html#methodgetContentType">LoggerLayoutHtml::getContentType()</a> |
| </li> |
| </ul> |
| </div> |
| <a name="methodgetFooter" id="getFooter"><!-- --></a> |
| <div class="evenrow"> |
| |
| <div class="method-header"> |
| <span class="method-title">getFooter</span> (line <span class="line-number">58</span>) |
| </div> |
| |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">Returns the footer for the layout format.</p> |
| <ul class="tags"> |
| <li><span class="field">access:</span> public</li> |
| </ul> |
| |
| <div class="method-signature"> |
| <span class="method-result">string</span> |
| <span class="method-name"> |
| getFooter |
| </span> |
| () |
| </div> |
| |
| |
| |
| <hr class="separator" /> |
| <div class="notes">Redefined in descendants as:</div> |
| <ul class="redefinitions"> |
| <li> |
| <a href="../log4php/layouts/LoggerLayoutXml.html#methodgetFooter">LoggerLayoutXml::getFooter()</a> |
| </li> |
| <li> |
| <a href="../log4php/layouts/LoggerLayoutHtml.html#methodgetFooter">LoggerLayoutHtml::getFooter()</a> |
| </li> |
| </ul> |
| </div> |
| <a name="methodgetHeader" id="getHeader"><!-- --></a> |
| <div class="oddrow"> |
| |
| <div class="method-header"> |
| <span class="method-title">getHeader</span> (line <span class="line-number">66</span>) |
| </div> |
| |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">Returns the header for the layout format.</p> |
| <ul class="tags"> |
| <li><span class="field">access:</span> public</li> |
| </ul> |
| |
| <div class="method-signature"> |
| <span class="method-result">string</span> |
| <span class="method-name"> |
| getHeader |
| </span> |
| () |
| </div> |
| |
| |
| |
| <hr class="separator" /> |
| <div class="notes">Redefined in descendants as:</div> |
| <ul class="redefinitions"> |
| <li> |
| <a href="../log4php/layouts/LoggerLayoutXml.html#methodgetHeader">LoggerLayoutXml::getHeader()</a> |
| </li> |
| <li> |
| <a href="../log4php/layouts/LoggerLayoutHtml.html#methodgetHeader">LoggerLayoutHtml::getHeader()</a> |
| </li> |
| </ul> |
| </div> |
| <a name="methodwarn" id="warn"><!-- --></a> |
| <div class="evenrow"> |
| |
| <div class="method-header"> |
| <span class="method-title">warn</span> (line <span class="line-number">71</span>) |
| </div> |
| |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">Triggers a warning for this layout with the given message.</p> |
| <ul class="tags"> |
| <li><span class="field">access:</span> protected</li> |
| </ul> |
| |
| <div class="method-signature"> |
| <span class="method-result">void</span> |
| <span class="method-name"> |
| warn |
| </span> |
| (<span class="var-type"></span> <span class="var-name">$message</span>) |
| </div> |
| |
| <ul class="parameters"> |
| <li> |
| <span class="var-type"></span> |
| <span class="var-name">$message</span> </li> |
| </ul> |
| |
| <hr class="separator" /> |
| <div class="notes">Redefinition of:</div> |
| <dl> |
| <dt><a href="../log4php/LoggerConfigurable.html#methodwarn">LoggerConfigurable::warn()</a></dt> |
| <dd>Triggers a warning.</dd> |
| </dl> |
| |
| </div> |
| <h4>Inherited Methods</h4> |
| <a name='inherited_methods'><!-- --></a> |
| <!-- =========== Summary =========== --> |
| <p>Inherited From <span class="classname"><a href="../log4php/LoggerConfigurable.html">LoggerConfigurable</a></span></p> |
| <blockquote> |
| <span class="method-name"><a href="../log4php/LoggerConfigurable.html#methodsetBoolean">LoggerConfigurable::setBoolean()</a></span><br> |
| <span class="method-name"><a href="../log4php/LoggerConfigurable.html#methodsetFileSize">LoggerConfigurable::setFileSize()</a></span><br> |
| <span class="method-name"><a href="../log4php/LoggerConfigurable.html#methodsetInteger">LoggerConfigurable::setInteger()</a></span><br> |
| <span class="method-name"><a href="../log4php/LoggerConfigurable.html#methodsetLevel">LoggerConfigurable::setLevel()</a></span><br> |
| <span class="method-name"><a href="../log4php/LoggerConfigurable.html#methodsetNumeric">LoggerConfigurable::setNumeric()</a></span><br> |
| <span class="method-name"><a href="../log4php/LoggerConfigurable.html#methodsetPositiveInteger">LoggerConfigurable::setPositiveInteger()</a></span><br> |
| <span class="method-name"><a href="../log4php/LoggerConfigurable.html#methodsetString">LoggerConfigurable::setString()</a></span><br> |
| <span class="method-name"><a href="../log4php/LoggerConfigurable.html#methodwarn">LoggerConfigurable::warn()</a></span><br> |
| </blockquote> |
| |
| </div> |
| </div> |
| |
| |
| <p class="notes" id="credit"> |
| Documentation generated on Sat, 18 Feb 2012 22:32:24 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a> |
| </p> |
| </div></body> |
| </html> |
