| <?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 LoggerLayoutXml</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 LoggerLayoutXml</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-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| |
| <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>) |
| |
| </div> |
| <div class="info-box-body"> |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">The output of the LoggerXmlLayout consists of a series of log4php:event elements.</p> |
| <p class="description"><p>Configurable parameters: <ul><li><a href="../../log4php/layouts/LoggerLayoutXml.html#var$locationInfo">$locationInfo</a> - If set to true then the file name and line number |
| of the origin of the log statement will be included in output.</li><li><a href="../../log4php/layouts/LoggerLayoutXml.html#var$log4jNamespace">$log4jNamespace</a> - If set to true then log4j namespace will be used |
| instead of log4php namespace. This can be usefull when using log viewers |
| which can only parse the log4j namespace such as Apache Chainsaw.</li></ul> <p>It does not output a complete well-formed XML file. The output is designed to be included as an external entity in a separate file to form a correct XML file.</p></p><p>Example:</p><p><div class="src-code"><ol><li><div class="src-line"><span class="src-inc">require_once </span><span class="src-id">dirname</span><span class="src-sym">(</span>__FILE__<span class="src-sym">)</span>.<span class="src-str">'/../../main/php/Logger.php'</span><span class="src-sym">;</span></div></li> |
| <li><div class="src-line"> </div></li> |
| <li><div class="src-line"><span class="src-id"><a href="../../log4php/Logger.html">Logger</a></span><span class="src-sym">::</span><a href="../../log4php/Logger.html#methodconfigure">configure</a><span class="src-sym">(</span><a href="http://www.php.net/dirname">dirname</a><span class="src-sym">(</span>__FILE__<span class="src-sym">)</span>.<span class="src-str">'/../resources/layout_xml.properties'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li> |
| <li><div class="src-line"><span class="src-var">$logger </span>= <span class="src-id"><a href="../../log4php/Logger.html">Logger</a></span><span class="src-sym">::</span><a href="../../log4php/Logger.html#methodgetRootLogger">getRootLogger</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li> |
| <li><div class="src-line"><span class="src-var">$logger</span><span class="src-sym">-></span><span class="src-id">info</span><span class="src-sym">(</span><span class="src-str">"Hello World!"</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li> |
| </ol></div><br /></p><p><div class="src-code"><ol><li><div class="src-line">log4php.appender.default = LoggerAppenderEcho</div></li> |
| <li><div class="src-line">log4php.appender.default.layout = LoggerLayoutXml</div></li> |
| <li><div class="src-line">log4php.rootLogger = DEBUG, default</div></li> |
| </ol></div><br /></p><p>The above would print:</p><p><pre> <log4php:eventSet xmlns:log4php="http://logging.apache.org/log4php/" version="0.3" includesLocationInfo="true"> |
| <log4php:event logger="root" level="INFO" thread="13802" timestamp="1252456226491"> |
| <log4php:message><![CDATA[Hello World!]]></log4php:message> |
| <log4php:locationInfo class="main" file="examples/php/layout_xml.php" line="6" method="main" /> |
| </log4php:event> |
| </log4php:eventSet></pre></p></p> |
| <ul class="tags"> |
| <li><span class="field">version:</span> $Revision: 1213283 $</li> |
| </ul> |
| <p class="notes"> |
| Located in <a class="field" href="_layouts---LoggerLayoutXml.php.html">/layouts/LoggerLayoutXml.php</a> (line <span class="field">56</span>) |
| </p> |
| |
| |
| <pre><a href="../../log4php/LoggerConfigurable.html">LoggerConfigurable</a> |
| | |
| --<a href="../../log4php/LoggerLayout.html">LoggerLayout</a> |
| | |
| --LoggerLayoutXml</pre> |
| |
| </div> |
| </div> |
| |
| |
| <a name="sec-const-summary"></a> |
| <div class="info-box"> |
| <div class="info-box-title">Class Constant Summary</span></div> |
| <div class="nav-bar"> |
| <a href="#sec-description">Description</a> | |
| <span class="disabled">Constants</span> (<a href="#sec-consts">details</a>) |
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| |
| | |
| | |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| |
| </div> |
| <div class="info-box-body"> |
| <div class="const-summary"> |
| <div class="const-title"> |
| <img src="../../media/images/Constant.png" alt=" " /> |
| <a href="#CDATA_EMBEDDED_END" title="details" class="const-name">CDATA_EMBEDDED_END</a> = <span class="var-type"> ']]>]]&gt;<![CDATA['</span> |
| |
| </div> |
| <div class="const-title"> |
| <img src="../../media/images/Constant.png" alt=" " /> |
| <a href="#CDATA_END" title="details" class="const-name">CDATA_END</a> = <span class="var-type"> ']]>'</span> |
| |
| </div> |
| <div class="const-title"> |
| <img src="../../media/images/Constant.png" alt=" " /> |
| <a href="#CDATA_PSEUDO_END" title="details" class="const-name">CDATA_PSEUDO_END</a> = <span class="var-type"> ']]&gt;'</span> |
| |
| </div> |
| <div class="const-title"> |
| <img src="../../media/images/Constant.png" alt=" " /> |
| <a href="#CDATA_START" title="details" class="const-name">CDATA_START</a> = <span class="var-type"> '<![CDATA['</span> |
| |
| </div> |
| <div class="const-title"> |
| <img src="../../media/images/Constant.png" alt=" " /> |
| <a href="#LOG4J_NS" title="details" class="const-name">LOG4J_NS</a> = <span class="var-type"> 'http://jakarta.apache.org/log4j/'</span> |
| |
| </div> |
| <div class="const-title"> |
| <img src="../../media/images/Constant.png" alt=" " /> |
| <a href="#LOG4J_NS_PREFIX" title="details" class="const-name">LOG4J_NS_PREFIX</a> = <span class="var-type">'log4j'</span> |
| |
| </div> |
| <div class="const-title"> |
| <img src="../../media/images/Constant.png" alt=" " /> |
| <a href="#LOG4PHP_NS" title="details" class="const-name">LOG4PHP_NS</a> = <span class="var-type"> 'http://logging.apache.org/log4php/'</span> |
| |
| </div> |
| <div class="const-title"> |
| <img src="../../media/images/Constant.png" alt=" " /> |
| <a href="#LOG4PHP_NS_PREFIX" title="details" class="const-name">LOG4PHP_NS_PREFIX</a> = <span class="var-type"> 'log4php'</span> |
| |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <a name="sec-var-summary"></a> |
| <div class="info-box"> |
| <div class="info-box-title">Variable Summary</span></div> |
| <div class="nav-bar"> |
| <a href="#sec-description">Description</a> | |
| <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>) |
| | |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| |
| <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>) |
| |
| </div> |
| <div class="info-box-body"> |
| <div class="var-summary"> |
| <div class="var-title"> |
| <span class="var-type">boolean</span> |
| <a href="#$locationInfo" title="details" class="var-name">$locationInfo</a> |
| </div> |
| <div class="var-title"> |
| <span class="var-type">boolean</span> |
| <a href="#$log4jNamespace" title="details" class="var-name">$log4jNamespace</a> |
| </div> |
| <div class="var-title"> |
| <span class="var-type">mixed</span> |
| <a href="#$namespace" title="details" class="var-name">$namespace</a> |
| </div> |
| <div class="var-title"> |
| <span class="var-type">mixed</span> |
| <a href="#$namespacePrefix" title="details" class="var-name">$namespacePrefix</a> |
| </div> |
| </div> |
| </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-const-summary">Constants</a> (<a href="#sec-consts">details</a>) |
| |
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</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">void</span> |
| <a href="#encodeCDATA" title="details" class="method-name">encodeCDATA</a> |
| (<span class="var-type">string</span> <span class="var-name">$string</span>) |
| </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="#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">boolean</span> |
| <a href="#getLocationInfo" title="details" class="method-name">getLocationInfo</a> |
| () |
| </div> |
| |
| <div class="method-definition"> |
| <span class="method-result">boolean</span> |
| <a href="#getLog4jNamespace" title="details" class="method-name">getLog4jNamespace</a> |
| () |
| </div> |
| |
| <div class="method-definition"> |
| <span class="method-result">void</span> |
| <a href="#setLocationInfo" title="details" class="method-name">setLocationInfo</a> |
| (<span class="var-type"></span> <span class="var-name">$flag</span>) |
| </div> |
| |
| <div class="method-definition"> |
| <span class="method-result">void</span> |
| <a href="#setLog4jNamespace" title="details" class="method-name">setLog4jNamespace</a> |
| (<span class="var-type">boolean</span> <span class="var-name">$flag</span>) |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <a name="sec-vars"></a> |
| <div class="info-box"> |
| <div class="info-box-title">Variables</div> |
| <div class="nav-bar"> |
| <a href="#sec-description">Description</a> | |
| <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
| |
| |
| <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>) |
| |
| | |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| |
| </div> |
| <div class="info-box-body"> |
| <a name="var$locationInfo" id="$locationInfo"><!-- --></A> |
| <div class="oddrow"> |
| |
| <div class="var-header"> |
| <span class="var-title"> |
| <span class="var-type">boolean</span> |
| <span class="var-name">$locationInfo</span> |
| = <span class="var-default"> true</span> (line <span class="line-number">73</span>) |
| </span> |
| </div> |
| |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">If set to true then the file name and line number of the origin of the log statement will be output.</p> |
| <ul class="tags"> |
| <li><span class="field">access:</span> protected</li> |
| </ul> |
| |
| |
| |
| |
| |
| </div> |
| <a name="var$log4jNamespace" id="$log4jNamespace"><!-- --></A> |
| <div class="evenrow"> |
| |
| <div class="var-header"> |
| <span class="var-title"> |
| <span class="var-type">boolean</span> |
| <span class="var-name">$log4jNamespace</span> |
| = <span class="var-default"> false</span> (line <span class="line-number">80</span>) |
| </span> |
| </div> |
| |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">If set to true, log4j namespace will be used instead of the log4php namespace.</p> |
| <ul class="tags"> |
| <li><span class="field">access:</span> protected</li> |
| </ul> |
| |
| |
| |
| |
| |
| </div> |
| <a name="var$namespace" id="$namespace"><!-- --></A> |
| <div class="oddrow"> |
| |
| <div class="var-header"> |
| <span class="var-title"> |
| <span class="var-type">mixed</span> |
| <span class="var-name">$namespace</span> |
| = <span class="var-default"> self::LOG4PHP_NS</span> (line <span class="line-number">83</span>) |
| </span> |
| </div> |
| |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">The namespace in use.</p> |
| <ul class="tags"> |
| <li><span class="field">access:</span> protected</li> |
| </ul> |
| |
| |
| |
| |
| |
| </div> |
| <a name="var$namespacePrefix" id="$namespacePrefix"><!-- --></A> |
| <div class="evenrow"> |
| |
| <div class="var-header"> |
| <span class="var-title"> |
| <span class="var-type">mixed</span> |
| <span class="var-name">$namespacePrefix</span> |
| = <span class="var-default"> self::LOG4PHP_NS_PREFIX</span> (line <span class="line-number">86</span>) |
| </span> |
| </div> |
| |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">The namespace prefix in use</p> |
| <ul class="tags"> |
| <li><span class="field">access:</span> protected</li> |
| </ul> |
| |
| |
| |
| |
| |
| </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-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</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">88</span>) |
| </div> |
| |
| <!-- ========== Info from phpDoc block ========= --> |
| <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">Redefinition of:</div> |
| <dl> |
| <dt><a href="../../log4php/LoggerLayout.html#methodactivateOptions">LoggerLayout::activateOptions()</a></dt> |
| <dd>Activates options for this layout.</dd> |
| </dl> |
| |
| </div> |
| <a name="methodencodeCDATA" id="encodeCDATA"><!-- --></a> |
| <div class="evenrow"> |
| |
| <div class="method-header"> |
| <span class="method-title">encodeCDATA</span> (line <span class="line-number">205</span>) |
| </div> |
| |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">Encases a string in CDATA tags, and escapes any existing CDATA end tags already present in the string.</p> |
| <ul class="tags"> |
| <li><span class="field">access:</span> private</li> |
| </ul> |
| |
| <div class="method-signature"> |
| <span class="method-result">void</span> |
| <span class="method-name"> |
| encodeCDATA |
| </span> |
| (<span class="var-type">string</span> <span class="var-name">$string</span>) |
| </div> |
| |
| <ul class="parameters"> |
| <li> |
| <span class="var-type">string</span> |
| <span class="var-name">$string</span> </li> |
| </ul> |
| |
| |
| </div> |
| <a name="methodformat" id="format"><!-- --></a> |
| <div class="oddrow"> |
| |
| <div class="method-header"> |
| <span class="method-title">format</span> (line <span class="line-number">115</span>) |
| </div> |
| |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">Formats a <a href="../../log4php/LoggerLoggingEvent.html">LoggerLoggingEvent</a> in conformance with the log4php.dtd.</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">Redefinition of:</div> |
| <dl> |
| <dt><a href="../../log4php/LoggerLayout.html#methodformat">LoggerLayout::format()</a></dt> |
| <dd>Override this method to create your own layout format.</dd> |
| </dl> |
| |
| </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">162</span>) |
| </div> |
| |
| <!-- ========== Info from phpDoc block ========= --> |
| <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">Redefinition of:</div> |
| <dl> |
| <dt><a href="../../log4php/LoggerLayout.html#methodgetFooter">LoggerLayout::getFooter()</a></dt> |
| <dd>Returns the footer for the layout format.</dd> |
| </dl> |
| |
| </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">101</span>) |
| </div> |
| |
| <!-- ========== Info from phpDoc block ========= --> |
| <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">Redefinition of:</div> |
| <dl> |
| <dt><a href="../../log4php/LoggerLayout.html#methodgetHeader">LoggerLayout::getHeader()</a></dt> |
| <dd>Returns the header for the layout format.</dd> |
| </dl> |
| |
| </div> |
| <a name="methodgetLocationInfo" id="getLocationInfo"><!-- --></a> |
| <div class="evenrow"> |
| |
| <div class="method-header"> |
| <span class="method-title">getLocationInfo</span> (line <span class="line-number">171</span>) |
| </div> |
| |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">Whether or not file name and line number will be included in the output.</p> |
| <ul class="tags"> |
| <li><span class="field">access:</span> public</li> |
| </ul> |
| |
| <div class="method-signature"> |
| <span class="method-result">boolean</span> |
| <span class="method-name"> |
| getLocationInfo |
| </span> |
| () |
| </div> |
| |
| |
| |
| </div> |
| <a name="methodgetLog4jNamespace" id="getLog4jNamespace"><!-- --></a> |
| <div class="oddrow"> |
| |
| <div class="method-header"> |
| <span class="method-title">getLog4jNamespace</span> (line <span class="line-number">189</span>) |
| </div> |
| |
| <!-- ========== Info from phpDoc block ========= --> |
| <ul class="tags"> |
| <li><span class="field">access:</span> public</li> |
| </ul> |
| |
| <div class="method-signature"> |
| <span class="method-result">boolean</span> |
| <span class="method-name"> |
| getLog4jNamespace |
| </span> |
| () |
| </div> |
| |
| |
| |
| </div> |
| <a name="methodsetLocationInfo" id="setLocationInfo"><!-- --></a> |
| <div class="evenrow"> |
| |
| <div class="method-header"> |
| <span class="method-title">setLocationInfo</span> (line <span class="line-number">182</span>) |
| </div> |
| |
| <!-- ========== Info from phpDoc block ========= --> |
| <p class="short-description">The $locationInfo option takes a boolean value. By default,</p> |
| <p class="description"><p>it is set to false which means there will be no location information output by this layout. If the the option is set to true, then the file name and line number of the statement at the origin of the log statement will be output.</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"> |
| setLocationInfo |
| </span> |
| (<span class="var-type"></span> <span class="var-name">$flag</span>) |
| </div> |
| |
| <ul class="parameters"> |
| <li> |
| <span class="var-type"></span> |
| <span class="var-name">$flag</span> </li> |
| </ul> |
| |
| |
| </div> |
| <a name="methodsetLog4jNamespace" id="setLog4jNamespace"><!-- --></a> |
| <div class="oddrow"> |
| |
| <div class="method-header"> |
| <span class="method-title">setLog4jNamespace</span> (line <span class="line-number">196</span>) |
| </div> |
| |
| <!-- ========== Info from phpDoc block ========= --> |
| <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"> |
| setLog4jNamespace |
| </span> |
| (<span class="var-type">boolean</span> <span class="var-name">$flag</span>) |
| </div> |
| |
| <ul class="parameters"> |
| <li> |
| <span class="var-type">boolean</span> |
| <span class="var-name">$flag</span> </li> |
| </ul> |
| |
| |
| </div> |
| <h4>Inherited Methods</h4> |
| <a name='inherited_methods'><!-- --></a> |
| <!-- =========== Summary =========== --> |
| <p>Inherited From <span class="classname"><a href="../../log4php/LoggerLayout.html">LoggerLayout</a></span></p> |
| <blockquote> |
| <span class="method-name"><a href="../../log4php/LoggerLayout.html#methodactivateOptions">LoggerLayout::activateOptions()</a></span><br> |
| <span class="method-name"><a href="../../log4php/LoggerLayout.html#methodformat">LoggerLayout::format()</a></span><br> |
| <span class="method-name"><a href="../../log4php/LoggerLayout.html#methodgetContentType">LoggerLayout::getContentType()</a></span><br> |
| <span class="method-name"><a href="../../log4php/LoggerLayout.html#methodgetFooter">LoggerLayout::getFooter()</a></span><br> |
| <span class="method-name"><a href="../../log4php/LoggerLayout.html#methodgetHeader">LoggerLayout::getHeader()</a></span><br> |
| <span class="method-name"><a href="../../log4php/LoggerLayout.html#methodwarn">LoggerLayout::warn()</a></span><br> |
| </blockquote> |
| <!-- =========== 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> |
| |
| <a name="sec-consts"></a> |
| <div class="info-box"> |
| <div class="info-box-title">Class Constants</div> |
| <div class="nav-bar"> |
| <a href="#sec-description">Description</a> | |
| <a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>) |
| |
| |
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| | |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| |
| </div> |
| <div class="info-box-body"> |
| <a name="constCDATA_EMBEDDED_END" id="CDATA_EMBEDDED_END"><!-- --></A> |
| <div class="evenrow"> |
| |
| <div class="const-header"> |
| <img src="../../media/images/Variable.png" /> |
| <span class="const-title"> |
| <span class="const-name">CDATA_EMBEDDED_END</span> |
| = <span class="const-default"> ']]>]]&gt;<![CDATA['</span> |
| (line <span class="line-number">66</span>) |
| </span> |
| </div> |
| |
| <!-- ========== Info from phpDoc block ========= --> |
| |
| |
| </div> |
| <a name="constCDATA_END" id="CDATA_END"><!-- --></A> |
| <div class="oddrow"> |
| |
| <div class="const-header"> |
| <img src="../../media/images/Variable.png" /> |
| <span class="const-title"> |
| <span class="const-name">CDATA_END</span> |
| = <span class="const-default"> ']]>'</span> |
| (line <span class="line-number">64</span>) |
| </span> |
| </div> |
| |
| <!-- ========== Info from phpDoc block ========= --> |
| |
| |
| </div> |
| <a name="constCDATA_PSEUDO_END" id="CDATA_PSEUDO_END"><!-- --></A> |
| <div class="evenrow"> |
| |
| <div class="const-header"> |
| <img src="../../media/images/Variable.png" /> |
| <span class="const-title"> |
| <span class="const-name">CDATA_PSEUDO_END</span> |
| = <span class="const-default"> ']]&gt;'</span> |
| (line <span class="line-number">65</span>) |
| </span> |
| </div> |
| |
| <!-- ========== Info from phpDoc block ========= --> |
| |
| |
| </div> |
| <a name="constCDATA_START" id="CDATA_START"><!-- --></A> |
| <div class="oddrow"> |
| |
| <div class="const-header"> |
| <img src="../../media/images/Variable.png" /> |
| <span class="const-title"> |
| <span class="const-name">CDATA_START</span> |
| = <span class="const-default"> '<