Google Git
Sign in
apache / logging-site / a4f88a44f9ece0268ea2d36ba57a00f2b881cabc / . / content / log4php / 2.2.1 / apidocs / log4php / configurators / LoggerConfigurationAdapterXML.html
blob: 842f7946079c3de1dd6e3061a1b64564b6d816c3 [file] [log] [blame]
<?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 LoggerConfigurationAdapterXML</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 LoggerConfigurationAdapterXML</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">
<p class="implements">
Implements interfaces:
<ul>
<li><a href="../../log4php/configurators/LoggerConfigurationAdapter.html">LoggerConfigurationAdapter</a></li> </ul>
</p>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Converts XML configuration files to a PHP array.</p>
<ul class="tags">
<li><span class="field">version:</span> $Revision$</li>
<li><span class="field">since:</span> 2.2</li>
<li><span class="field">license:</span> <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a></li>
</ul>
<p class="notes">
Located in <a class="field" href="_configurators---LoggerConfigurationAdapterXML.php.html">/configurators/LoggerConfigurationAdapterXML.php</a> (line <span class="field">30</span>)
</p>
<pre></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="#SCHEMA_PATH" title="details" class="const-name">SCHEMA_PATH</a> = <span class="var-type"> '/../xml/log4php.xsd'</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">mixed</span>
<a href="#$config" title="details" class="var-name">$config</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="#convert" title="details" class="method-name">convert</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$url</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#getAttributeValue" title="details" class="method-name">getAttributeValue</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$node</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$name</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#loadXML" title="details" class="method-name">loadXML</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#parseAppender" title="details" class="method-name">parseAppender</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$node</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#parseAppenderReferences" title="details" class="method-name">parseAppenderReferences</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$node</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$name</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#parseConfiguration" title="details" class="method-name">parseConfiguration</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$xml</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#parseFilter" title="details" class="method-name">parseFilter</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$filterNode</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#parseLayout" title="details" class="method-name">parseLayout</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$node</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$appenderName</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#parseLogger" title="details" class="method-name">parseLogger</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$node</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#parseParameters" title="details" class="method-name">parseParameters</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$paramsNode</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#parseRenderer" title="details" class="method-name">parseRenderer</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$node</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#parseRootLogger" title="details" class="method-name">parseRootLogger</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$node</span>)
</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>&nbsp;<span class="var-name">$message</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$config" id="$config"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">mixed</span>
<span class="var-name">$config</span>
= <span class="var-default">array(
<br /> 'appenders' =&gt; array(),'loggers'=&gt;array(),'renderers'=&gt;array(),)</span> (line <span class="line-number">35</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> private</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="methodconvert" id="convert"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">convert</span> (line <span class="line-number">41</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">
convert
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$url</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$url</span> </li>
</ul>
<hr class="separator" />
<div class="notes">Implementation of:</div>
<dl>
<dt><a href="../../log4php/configurators/LoggerConfigurationAdapter.html#methodconvert">LoggerConfigurationAdapter::convert()</a></dt>
<dd>Converts the configuration file to PHP format usable by the configurator.</dd>
</dl>
</div>
<a name="methodgetAttributeValue" id="getAttributeValue"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">getAttributeValue</span> (line <span class="line-number">249</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<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">
getAttributeValue
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$node</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$name</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">SimpleXMLElement</span>
<span class="var-name">$node</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$name</span> </li>
</ul>
</div>
<a name="methodloadXML" id="loadXML"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">loadXML</span> (line <span class="line-number">73</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Loads and validates the XML.</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">
loadXML
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$url</span><span class="var-description">: Input XML.</span> </li>
</ul>
</div>
<a name="methodparseAppender" id="parseAppender"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">parseAppender</span> (line <span class="line-number">110</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Parses an &lt;appender&gt; node.</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">
parseAppender
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$node</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">SimpleXMLElement</span>
<span class="var-name">$node</span> </li>
</ul>
</div>
<a name="methodparseAppenderReferences" id="parseAppenderReferences"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">parseAppenderReferences</span> (line <span class="line-number">216</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Parses a &lt;logger&gt; node for appender references and returns them in an array.</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">
parseAppenderReferences
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$node</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$name</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">SimpleXMLElement</span>
<span class="var-name">$node</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$name</span> </li>
</ul>
</div>
<a name="methodparseConfiguration" id="parseConfiguration"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">parseConfiguration</span> (line <span class="line-number">102</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Parses the &lt;configuration&gt; node.</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">
parseConfiguration
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$xml</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">SimpleXMLElement</span>
<span class="var-name">$xml</span> </li>
</ul>
</div>
<a name="methodparseFilter" id="parseFilter"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">parseFilter</span> (line <span class="line-number">226</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Parses a &lt;filter&gt; node.</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">
parseFilter
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$filterNode</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$filterNode</span> </li>
</ul>
</div>
<a name="methodparseLayout" id="parseLayout"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">parseLayout</span> (line <span class="line-number">140</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Parses a &lt;layout&gt; node.</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">
parseLayout
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$node</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$appenderName</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">SimpleXMLElement</span>
<span class="var-name">$node</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$appenderName</span> </li>
</ul>
</div>
<a name="methodparseLogger" id="parseLogger"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">parseLogger</span> (line <span class="line-number">186</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Parses a &lt;logger&gt; node.</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">
parseLogger
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$node</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">SimpleXMLElement</span>
<span class="var-name">$node</span> </li>
</ul>
</div>
<a name="methodparseParameters" id="parseParameters"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">parseParameters</span> (line <span class="line-number">151</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Parses any &lt;param&gt; child nodes returning them in an array.</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">
parseParameters
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$paramsNode</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$paramsNode</span> </li>
</ul>
</div>
<a name="methodparseRenderer" id="parseRenderer"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">parseRenderer</span> (line <span class="line-number">238</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Parses a &lt;renderer&gt; node.</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">
parseRenderer
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$node</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">SimpleXMLElement</span>
<span class="var-name">$node</span> </li>
</ul>
</div>
<a name="methodparseRootLogger" id="parseRootLogger"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">parseRootLogger</span> (line <span class="line-number">170</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Parses a &lt;root&gt; node.</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">
parseRootLogger
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$node</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">SimpleXMLElement</span>
<span class="var-name">$node</span> </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">253</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<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">
warn
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$message</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$message</span> </li>
</ul>
</div>
</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="constSCHEMA_PATH" id="SCHEMA_PATH"><!-- --></A>
<div class="oddrow">
<div class="const-header">
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">SCHEMA_PATH</span>
= <span class="const-default"> '/../xml/log4php.xsd'</span>
(line <span class="line-number">33</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Path to the XML schema used for validation.</p>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Sat, 18 Feb 2012 22:32:23 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>