Google Git
Sign in
apache / logging-site / a4f88a44f9ece0268ea2d36ba57a00f2b881cabc / . / content / log4php / 2.2.1 / apidocs / log4php / configurators / LoggerConfigurationAdapterINI.html
blob: 101c826dd59551c17d9f36f4e2a9e7777d34d6cb [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 LoggerConfigurationAdapterINI</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 LoggerConfigurationAdapterINI</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 ini configuration files to a PHP array.</p>
<p class="description"><p>These used to be called &quot;properties&quot; files (inherited from log4j), and that file extension is still supported.</p></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---LoggerConfigurationAdapterINI.php.html">/configurators/LoggerConfigurationAdapterINI.php</a> (line <span class="field">33</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="#ADDITIVITY_PREFIX" title="details" class="const-name">ADDITIVITY_PREFIX</a> = <span class="var-type"> &quot;log4php.additivity.&quot;</span>
</div>
<div class="const-title">
<img src="../../media/images/Constant.png" alt=" " />
<a href="#APPENDER_PREFIX" title="details" class="const-name">APPENDER_PREFIX</a> = <span class="var-type"> &quot;log4php.appender.&quot;</span>
</div>
<div class="const-title">
<img src="../../media/images/Constant.png" alt=" " />
<a href="#LOGGER_PREFIX" title="details" class="const-name">LOGGER_PREFIX</a> = <span class="var-type"> &quot;log4php.logger.&quot;</span>
</div>
<div class="const-title">
<img src="../../media/images/Constant.png" alt=" " />
<a href="#RENDERER_PREFIX" title="details" class="const-name">RENDERER_PREFIX</a> = <span class="var-type"> &quot;log4php.renderer.&quot;</span>
</div>
<div class="const-title">
<img src="../../media/images/Constant.png" alt=" " />
<a href="#ROOT_LOGGER_NAME" title="details" class="const-name">ROOT_LOGGER_NAME</a> = <span class="var-type"> &quot;root&quot;</span>
</div>
<div class="const-title">
<img src="../../media/images/Constant.png" alt=" " />
<a href="#ROOT_LOGGER_PREFIX" title="details" class="const-name">ROOT_LOGGER_PREFIX</a> = <span class="var-type"> &quot;log4php.rootLogger&quot;</span>
</div>
<div class="const-title">
<img src="../../media/images/Constant.png" alt=" " />
<a href="#THRESHOLD_PREFIX" title="details" class="const-name">THRESHOLD_PREFIX</a> = <span class="var-type"> &quot;log4php.threshold&quot;</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="#beginsWith" title="details" class="method-name">beginsWith</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$str</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$sub</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#convert" title="details" class="method-name">convert</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$path</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#load" title="details" class="method-name">load</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">string</span>&nbsp;<span class="var-name">$key</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</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">string</span>&nbsp;<span class="var-name">$value</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$name</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">string</span>&nbsp;<span class="var-name">$key</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</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="evenrow">
<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()</span> (line <span class="line-number">57</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Holds the configuration.</p>
<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="methodbeginsWith" id="beginsWith"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">beginsWith</span> (line <span class="line-number">293</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Helper method. Returns true if $str begins with $sub.</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">
beginsWith
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$str</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$sub</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$str</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$sub</span> </li>
</ul>
</div>
<a name="methodconvert" id="convert"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">convert</span> (line <span class="line-number">85</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Converts the provided INI configuration file to a PHP array config.</p>
<ul class="tags">
<li><span class="field">throws:</span> LoggerException If the file cannot be loaded or parsed.</li>
<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">string</span>&nbsp;<span class="var-name">$path</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$path</span><span class="var-description">: Path to the config file.</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="methodload" id="load"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">load</span> (line <span class="line-number">65</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Loads and parses the INI configuration file.</p>
<ul class="tags">
<li><span class="field">throws:</span> LoggerException</li>
<li><span class="field">access:</span> private</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
load
</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">: Path to the config file.</span> </li>
</ul>
</div>
<a name="methodparseAppender" id="parseAppender"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">parseAppender</span> (line <span class="line-number">229</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Parses an configuration line pertaining to an appender.</p>
<p class="description"><p>Parses the following patterns:</p><p>Appender class: <pre> log4php.appender.<name> = <class></pre></p><p>Appender parameter: <pre> log4php.appender.<name>.<param> = <value></pre></p><p>Appender threshold: <pre> log4php.appender.<name>.threshold = <level></pre></p><p>Appender layout: <pre> log4php.appender.<name>.layout = <layoutClass></pre></p><p>Layout parameter: <pre> log4php.appender.<name>.layout.<param> = <value></pre></p><p>For example, a full appender config might look like: <pre> log4php.appender.myAppender = LoggerAppenderConsole
log4php.appender.myAppender.threshold = info
log4php.appender.myAppender.target = stdout
log4php.appender.myAppender.layout = LoggerLayoutPattern
log4php.appender.myAppender.layout.conversionPattern = "%d %c: %m%n"</pre></p><p>After parsing all these options, the following configuration can be found under $this-&gt;config['appenders']['myAppender']: <pre> array(
'class' => LoggerAppenderConsole,
'threshold' => info,
'params' => array(
'target' => 'stdout'
),
'layout' => array(
'class' => 'LoggerAppenderConsole',
'params' => array(
'conversionPattern' => '%d %c: %m%n'
)
)
)</pre></p></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">string</span>&nbsp;<span class="var-name">$key</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$key</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$value</span> </li>
</ul>
</div>
<a name="methodparseLogger" id="parseLogger"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">parseLogger</span> (line <span class="line-number">140</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Parses a logger definition.</p>
<p class="description"><p>Loggers are defined in the following manner: <pre> log4php.logger.<name> = [<level>], [<appender-ref>, <appender-ref>, ...]</pre></p></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">string</span>&nbsp;<span class="var-name">$value</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$value</span><span class="var-description">: The configuration value (level and appender-refs).</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$name</span><span class="var-description">: Logger name.</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">284</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Parses a renderer definition.</p>
<p class="description"><p>Renderers are defined as: <pre> log4php.renderer.<renderedClass> = <renderingClass></pre></p></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">string</span>&nbsp;<span class="var-name">$key</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$key</span><span class="var-description">: log4php.renderer.&lt;renderedClass&gt;</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$value</span><span class="var-description">: &lt;renderingClass&gt;</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="constADDITIVITY_PREFIX" id="ADDITIVITY_PREFIX"><!-- --></A>
<div class="oddrow">
<div class="const-header">
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">ADDITIVITY_PREFIX</span>
= <span class="const-default"> &quot;log4php.additivity.&quot;</span>
(line <span class="line-number">39</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Prefix used for defining logger additivity.</p>
</div>
<a name="constAPPENDER_PREFIX" id="APPENDER_PREFIX"><!-- --></A>
<div class="evenrow">
<div class="const-header">
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">APPENDER_PREFIX</span>
= <span class="const-default"> &quot;log4php.appender.&quot;</span>
(line <span class="line-number">51</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Prefix used for defining an appender.</p>
</div>
<a name="constLOGGER_PREFIX" id="LOGGER_PREFIX"><!-- --></A>
<div class="oddrow">
<div class="const-header">
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">LOGGER_PREFIX</span>
= <span class="const-default"> &quot;log4php.logger.&quot;</span>
(line <span class="line-number">48</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Prefix used for defining a logger.</p>
</div>
<a name="constRENDERER_PREFIX" id="RENDERER_PREFIX"><!-- --></A>
<div class="evenrow">
<div class="const-header">
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">RENDERER_PREFIX</span>
= <span class="const-default"> &quot;log4php.renderer.&quot;</span>
(line <span class="line-number">54</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Prefix used for defining a renderer.</p>
</div>
<a name="constROOT_LOGGER_NAME" id="ROOT_LOGGER_NAME"><!-- --></A>
<div class="oddrow">
<div class="const-header">
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">ROOT_LOGGER_NAME</span>
= <span class="const-default"> &quot;root&quot;</span>
(line <span class="line-number">36</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Name to assign to the root logger.</p>
</div>
<a name="constROOT_LOGGER_PREFIX" id="ROOT_LOGGER_PREFIX"><!-- --></A>
<div class="evenrow">
<div class="const-header">
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">ROOT_LOGGER_PREFIX</span>
= <span class="const-default"> &quot;log4php.rootLogger&quot;</span>
(line <span class="line-number">45</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Prefix used for defining the root logger.</p>
</div>
<a name="constTHRESHOLD_PREFIX" id="THRESHOLD_PREFIX"><!-- --></A>
<div class="oddrow">
<div class="const-header">
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">THRESHOLD_PREFIX</span>
= <span class="const-default"> &quot;log4php.threshold&quot;</span>
(line <span class="line-number">42</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Prefix used for defining logger threshold.</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>