content/log4php/2.3.0/apidocs/class-LoggerConfigurationAdapterINI.html - logging-site - Git at Google

 <!DOCTYPE html>
 <html>
 <head>
 	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 	<meta name="generator" content="ApiGen 2.8.0" />

 	<title>Class LoggerConfigurationAdapterINI | Apache log4php</title>

 	<script type="text/javascript" src="resources/combined.js?238209907"></script>
 	<script type="text/javascript" src="elementlist.js?4055067042"></script>
 	<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />

 	<script type="text/javascript">
 		var _gaq = _gaq || [];
 		_gaq.push(['_setAccount', "UA-26177991-1"]);
 		_gaq.push(['_trackPageview']);

 		(function() {
 			var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
 			ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
 			var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
 		})();
 	</script>
 </head>

 <body>
 <div id="left">
 	<div id="menu">
 		<a href="index.html" title="Overview"><span>Overview</span></a>


 		<div id="groups">
 			<h3>Packages</h3>
 			<ul>
 				<li class="active"><a href="package-log4php.html">log4php<span></span></a>
 						<ul>
 				<li><a href="package-log4php.appenders.html">appenders</a>
 						</li>
 				<li class="active"><a href="package-log4php.configurators.html">configurators</a>
 						</li>
 				<li><a href="package-log4php.filters.html">filters</a>
 						</li>
 				<li><a href="package-log4php.helpers.html">helpers</a>
 						</li>
 				<li><a href="package-log4php.layouts.html">layouts</a>
 						</li>
 				<li><a href="package-log4php.pattern.html">pattern</a>
 						</li>
 				<li><a href="package-log4php.renderers.html">renderers</a>
 						</li>
 							</ul></li>
 			</ul>
 		</div>

 		<hr />


 		<div id="elements">
 			<h3>Classes</h3>
 			<ul>
 				<li class="active"><a href="class-LoggerConfigurationAdapterINI.html">LoggerConfigurationAdapterINI</a></li>
 				<li><a href="class-LoggerConfigurationAdapterPHP.html">LoggerConfigurationAdapterPHP</a></li>
 				<li><a href="class-LoggerConfigurationAdapterXML.html">LoggerConfigurationAdapterXML</a></li>
 			</ul>

 			<h3>Interfaces</h3>
 			<ul>
 				<li><a href="class-LoggerConfigurationAdapter.html">LoggerConfigurationAdapter</a></li>
 			</ul>


 		</div>
 	</div>
 </div>

 <div id="splitter"></div>

 <div id="right">
 <div id="rightInner">
 	<form id="search">
 		<input type="hidden" name="cx" value="" />
 		<input type="hidden" name="ie" value="UTF-8" />
 		<input type="text" name="q" class="text" />
 		<input type="submit" value="Search" />
 	</form>

 	<div id="navigation">
 		<ul>
 			<li>
 				<a href="index.html" title="Overview"><span>Overview</span></a>
 			</li>
 			<li>
 				<a href="package-log4php.configurators.html" title="Summary of log4php\configurators"><span>Package</span></a>
 			</li>
 			<li class="active">
 <span>Class</span>			</li>
 		</ul>
 		<ul>
 			<li>
 				<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
 			</li>
 		</ul>
 		<ul>
 		</ul>
 	</div>

 <div id="content" class="class">
 	<h1>Class LoggerConfigurationAdapterINI</h1>


 	<div class="description">

 <p>Converts ini configuration files to a PHP array.</p>

 <p>These used to be called "properties" files (inherited from log4j), and that
 file extension is still supported.</p>

 	</div>

 	<dl class="tree">
 		<dd style="padding-left:0px">
 <b><span>LoggerConfigurationAdapterINI</span></b>
 			 implements
 				<a href="class-LoggerConfigurationAdapter.html"><span>LoggerConfigurationAdapter</span></a>


 		</dd>
 	</dl>


 	<div class="info">


 		<b>Package:</b> <a href="package-log4php.html">log4php</a>\<a href="package-log4php.configurators.html">configurators</a><br />

 				<b>License:</b>
 				<a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a><br />
 				<b>Version:</b>
 				$Revision: 1343601 $<br />
 				<b>Since:</b>
 				2.2<br />
 		<b>Located at</b> <a href="source-class-LoggerConfigurationAdapterINI.html#21-298" title="Go to source code">configurators/LoggerConfigurationAdapterINI.php</a><br />
 	</div>


 	<table class="summary" id="methods">
 	<caption>Methods summary</caption>
 	<tr data-order="convert" id="_convert">

 		<td class="attributes"><code>
 			 public


 			</code>
 		</td>

 		<td class="name"><div>
 		<a class="anchor" href="#_convert">#</a>
 		<code><a href="source-class-LoggerConfigurationAdapterINI.html#79-126" title="Go to source code">convert</a>( <span>string <var>$path</var></span> )</code>

 		<div class="description short">

 <p>Converts the provided INI configuration file to a PHP array config.</p>

 		</div>

 		<div class="description detailed hidden">

 <p>Converts the provided INI configuration file to a PHP array config.</p>


 				<h4>Parameters</h4>
 				<div class="list"><dl>
 					<dt><var>$path</var></dt>
 					<dd><code>string</code><br>$path Path to the config file.</dd>
 				</dl></div>


 				<h4>Throws</h4>
 				<div class="list">
 					<code><code><a href="class-LoggerException.html">LoggerException</a></code></code><br>If the file cannot be loaded or parsed.<br />
 				</div>


 				<h4>Implementation of</h4>
 				<div class="list"><code><a href="class-LoggerConfigurationAdapter.html#_convert">LoggerConfigurationAdapter::convert()</a></code></div>
 		</div>
 		</div></td>
 	</tr>
 	</table>


 	<table class="summary" id="constants">
 	<caption>Constants summary</caption>
 	<tr data-order="ROOT_LOGGER_NAME" id="ROOT_LOGGER_NAME">

 		<td class="attributes"><code>string</code></td>
 		<td class="name"><code>
 				<a href="source-class-LoggerConfigurationAdapterINI.html#35-36" title="Go to source code"><b>ROOT_LOGGER_NAME</b></a>
 		</code></td>
 		<td class="value"><code><span class="php-quote">&quot;root&quot;</span></code></td>
 		<td class="description"><div>
 			<a href="#ROOT_LOGGER_NAME" class="anchor">#</a>

 			<div class="description short">

 <p>Name to assign to the root logger.</p>

 			</div>

 			<div class="description detailed hidden">

 <p>Name to assign to the root logger.</p>


 			</div>
 		</div></td>
 	</tr>
 	<tr data-order="ADDITIVITY_PREFIX" id="ADDITIVITY_PREFIX">

 		<td class="attributes"><code>string</code></td>
 		<td class="name"><code>
 				<a href="source-class-LoggerConfigurationAdapterINI.html#38-39" title="Go to source code"><b>ADDITIVITY_PREFIX</b></a>
 		</code></td>
 		<td class="value"><code><span class="php-quote">&quot;log4php.additivity.&quot;</span></code></td>
 		<td class="description"><div>
 			<a href="#ADDITIVITY_PREFIX" class="anchor">#</a>

 			<div class="description short">

 <p>Prefix used for defining logger additivity.</p>

 			</div>

 			<div class="description detailed hidden">

 <p>Prefix used for defining logger additivity.</p>


 			</div>
 		</div></td>
 	</tr>
 	<tr data-order="THRESHOLD_PREFIX" id="THRESHOLD_PREFIX">

 		<td class="attributes"><code>string</code></td>
 		<td class="name"><code>
 				<a href="source-class-LoggerConfigurationAdapterINI.html#41-42" title="Go to source code"><b>THRESHOLD_PREFIX</b></a>
 		</code></td>
 		<td class="value"><code><span class="php-quote">&quot;log4php.threshold&quot;</span></code></td>
 		<td class="description"><div>
 			<a href="#THRESHOLD_PREFIX" class="anchor">#</a>

 			<div class="description short">

 <p>Prefix used for defining logger threshold.</p>

 			</div>

 			<div class="description detailed hidden">

 <p>Prefix used for defining logger threshold.</p>


 			</div>
 		</div></td>
 	</tr>
 	<tr data-order="ROOT_LOGGER_PREFIX" id="ROOT_LOGGER_PREFIX">

 		<td class="attributes"><code>string</code></td>
 		<td class="name"><code>
 				<a href="source-class-LoggerConfigurationAdapterINI.html#44-45" title="Go to source code"><b>ROOT_LOGGER_PREFIX</b></a>
 		</code></td>
 		<td class="value"><code><span class="php-quote">&quot;log4php.rootLogger&quot;</span></code></td>
 		<td class="description"><div>
 			<a href="#ROOT_LOGGER_PREFIX" class="anchor">#</a>

 			<div class="description short">

 <p>Prefix used for defining the root logger.</p>

 			</div>

 			<div class="description detailed hidden">

 <p>Prefix used for defining the root logger.</p>


 			</div>
 		</div></td>
 	</tr>
 	<tr data-order="LOGGER_PREFIX" id="LOGGER_PREFIX">

 		<td class="attributes"><code>string</code></td>
 		<td class="name"><code>
 				<a href="source-class-LoggerConfigurationAdapterINI.html#47-48" title="Go to source code"><b>LOGGER_PREFIX</b></a>
 		</code></td>
 		<td class="value"><code><span class="php-quote">&quot;log4php.logger.&quot;</span></code></td>
 		<td class="description"><div>
 			<a href="#LOGGER_PREFIX" class="anchor">#</a>

 			<div class="description short">

 <p>Prefix used for defining a logger.</p>

 			</div>

 			<div class="description detailed hidden">

 <p>Prefix used for defining a logger.</p>


 			</div>
 		</div></td>
 	</tr>
 	<tr data-order="APPENDER_PREFIX" id="APPENDER_PREFIX">

 		<td class="attributes"><code>string</code></td>
 		<td class="name"><code>
 				<a href="source-class-LoggerConfigurationAdapterINI.html#50-51" title="Go to source code"><b>APPENDER_PREFIX</b></a>
 		</code></td>
 		<td class="value"><code><span class="php-quote">&quot;log4php.appender.&quot;</span></code></td>
 		<td class="description"><div>
 			<a href="#APPENDER_PREFIX" class="anchor">#</a>

 			<div class="description short">

 <p>Prefix used for defining an appender.</p>

 			</div>

 			<div class="description detailed hidden">

 <p>Prefix used for defining an appender.</p>


 			</div>
 		</div></td>
 	</tr>
 	<tr data-order="RENDERER_PREFIX" id="RENDERER_PREFIX">

 		<td class="attributes"><code>string</code></td>
 		<td class="name"><code>
 				<a href="source-class-LoggerConfigurationAdapterINI.html#53-54" title="Go to source code"><b>RENDERER_PREFIX</b></a>
 		</code></td>
 		<td class="value"><code><span class="php-quote">&quot;log4php.renderer.&quot;</span></code></td>
 		<td class="description"><div>
 			<a href="#RENDERER_PREFIX" class="anchor">#</a>

 			<div class="description short">

 <p>Prefix used for defining a renderer.</p>

 			</div>

 			<div class="description detailed hidden">

 <p>Prefix used for defining a renderer.</p>


 			</div>
 		</div></td>
 	</tr>
 	</table>


 </div>

 	<div id="footer">
 		Apache log4php API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
 	</div>
 </div>
 </div>
 </body>
 </html>
	<!DOCTYPE html>
	<html>
	<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
	<meta name="generator" content="ApiGen 2.8.0" />

	<title>Class LoggerConfigurationAdapterINI \| Apache log4php</title>

	<script type="text/javascript" src="resources/combined.js?238209907"></script>
	<script type="text/javascript" src="elementlist.js?4055067042"></script>
	<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />

	<script type="text/javascript">
	var _gaq = _gaq \|\| [];
	_gaq.push(['_setAccount', "UA-26177991-1"]);
	_gaq.push(['_trackPageview']);

	(function() {
	var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
	ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
	var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
	})();
	</script>
	</head>

	<body>
	<div id="left">
	<div id="menu">
	<a href="index.html" title="Overview"><span>Overview</span></a>


	<div id="groups">
	<h3>Packages</h3>
	<ul>
	<li class="active"><a href="package-log4php.html">log4php<span></span></a>
	<ul>
	<li><a href="package-log4php.appenders.html">appenders</a>
	</li>
	<li class="active"><a href="package-log4php.configurators.html">configurators</a>
	</li>
	<li><a href="package-log4php.filters.html">filters</a>
	</li>
	<li><a href="package-log4php.helpers.html">helpers</a>
	</li>
	<li><a href="package-log4php.layouts.html">layouts</a>
	</li>
	<li><a href="package-log4php.pattern.html">pattern</a>
	</li>
	<li><a href="package-log4php.renderers.html">renderers</a>
	</li>
	</ul></li>
	</ul>
	</div>

	<hr />


	<div id="elements">
	<h3>Classes</h3>
	<ul>
	<li class="active"><a href="class-LoggerConfigurationAdapterINI.html">LoggerConfigurationAdapterINI</a></li>
	<li><a href="class-LoggerConfigurationAdapterPHP.html">LoggerConfigurationAdapterPHP</a></li>
	<li><a href="class-LoggerConfigurationAdapterXML.html">LoggerConfigurationAdapterXML</a></li>
	</ul>

	<h3>Interfaces</h3>
	<ul>
	<li><a href="class-LoggerConfigurationAdapter.html">LoggerConfigurationAdapter</a></li>
	</ul>




	</div>
	</div>
	</div>

	<div id="splitter"></div>

	<div id="right">
	<div id="rightInner">
	<form id="search">
	<input type="hidden" name="cx" value="" />
	<input type="hidden" name="ie" value="UTF-8" />
	<input type="text" name="q" class="text" />
	<input type="submit" value="Search" />
	</form>

	<div id="navigation">
	<ul>
	<li>
	<a href="index.html" title="Overview"><span>Overview</span></a>
	</li>
	<li>
	<a href="package-log4php.configurators.html" title="Summary of log4php\configurators"><span>Package</span></a>
	</li>
	<li class="active">
	<span>Class</span> </li>
	</ul>
	<ul>
	<li>
	<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
	</li>
	</ul>
	<ul>
	</ul>
	</div>

	<div id="content" class="class">
	<h1>Class LoggerConfigurationAdapterINI</h1>


	<div class="description">

	<p>Converts ini configuration files to a PHP array.</p>

	<p>These used to be called "properties" files (inherited from log4j), and that
	file extension is still supported.</p>

	</div>

	<dl class="tree">
	<dd style="padding-left:0px">
	<b><span>LoggerConfigurationAdapterINI</span></b>
	implements
	<a href="class-LoggerConfigurationAdapter.html"><span>LoggerConfigurationAdapter</span></a>


	</dd>
	</dl>








	<div class="info">



	<b>Package:</b> <a href="package-log4php.html">log4php</a>\<a href="package-log4php.configurators.html">configurators</a><br />

	<b>License:</b>
	<a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a><br />
	<b>Version:</b>
	$Revision: 1343601 $<br />
	<b>Since:</b>
	2.2<br />
	<b>Located at</b> <a href="source-class-LoggerConfigurationAdapterINI.html#21-298" title="Go to source code">configurators/LoggerConfigurationAdapterINI.php</a><br />
	</div>



	<table class="summary" id="methods">
	<caption>Methods summary</caption>
	<tr data-order="convert" id="_convert">

	<td class="attributes"><code>
	public


	</code>
	</td>

	<td class="name"><div>
	<a class="anchor" href="#_convert">#</a>
	<code><a href="source-class-LoggerConfigurationAdapterINI.html#79-126" title="Go to source code">convert</a>( <span>string <var>$path</var></span> )</code>

	<div class="description short">

	<p>Converts the provided INI configuration file to a PHP array config.</p>

	</div>

	<div class="description detailed hidden">

	<p>Converts the provided INI configuration file to a PHP array config.</p>



	<h4>Parameters</h4>
	<div class="list"><dl>
	<dt><var>$path</var></dt>
	<dd><code>string</code><br>$path Path to the config file.</dd>
	</dl></div>


	<h4>Throws</h4>
	<div class="list">
	<code><code><a href="class-LoggerException.html">LoggerException</a></code></code><br>If the file cannot be loaded or parsed.<br />
	</div>



	<h4>Implementation of</h4>
	<div class="list"><code><a href="class-LoggerConfigurationAdapter.html#_convert">LoggerConfigurationAdapter::convert()</a></code></div>
	</div>
	</div></td>
	</tr>
	</table>








	<table class="summary" id="constants">
	<caption>Constants summary</caption>
	<tr data-order="ROOT_LOGGER_NAME" id="ROOT_LOGGER_NAME">

	<td class="attributes"><code>string</code></td>
	<td class="name"><code>
	<a href="source-class-LoggerConfigurationAdapterINI.html#35-36" title="Go to source code"><b>ROOT_LOGGER_NAME</b></a>
	</code></td>
	<td class="value"><code><span class="php-quote">"root"</span></code></td>
	<td class="description"><div>
	<a href="#ROOT_LOGGER_NAME" class="anchor">#</a>

	<div class="description short">

	<p>Name to assign to the root logger.</p>

	</div>

	<div class="description detailed hidden">

	<p>Name to assign to the root logger.</p>


	</div>
	</div></td>
	</tr>
	<tr data-order="ADDITIVITY_PREFIX" id="ADDITIVITY_PREFIX">

	<td class="attributes"><code>string</code></td>
	<td class="name"><code>
	<a href="source-class-LoggerConfigurationAdapterINI.html#38-39" title="Go to source code"><b>ADDITIVITY_PREFIX</b></a>
	</code></td>
	<td class="value"><code><span class="php-quote">"log4php.additivity."</span></code></td>
	<td class="description"><div>
	<a href="#ADDITIVITY_PREFIX" class="anchor">#</a>

	<div class="description short">

	<p>Prefix used for defining logger additivity.</p>

	</div>

	<div class="description detailed hidden">

	<p>Prefix used for defining logger additivity.</p>


	</div>
	</div></td>
	</tr>
	<tr data-order="THRESHOLD_PREFIX" id="THRESHOLD_PREFIX">

	<td class="attributes"><code>string</code></td>
	<td class="name"><code>
	<a href="source-class-LoggerConfigurationAdapterINI.html#41-42" title="Go to source code"><b>THRESHOLD_PREFIX</b></a>
	</code></td>
	<td class="value"><code><span class="php-quote">"log4php.threshold"</span></code></td>
	<td class="description"><div>
	<a href="#THRESHOLD_PREFIX" class="anchor">#</a>

	<div class="description short">

	<p>Prefix used for defining logger threshold.</p>

	</div>

	<div class="description detailed hidden">

	<p>Prefix used for defining logger threshold.</p>


	</div>
	</div></td>
	</tr>
	<tr data-order="ROOT_LOGGER_PREFIX" id="ROOT_LOGGER_PREFIX">

	<td class="attributes"><code>string</code></td>
	<td class="name"><code>
	<a href="source-class-LoggerConfigurationAdapterINI.html#44-45" title="Go to source code"><b>ROOT_LOGGER_PREFIX</b></a>
	</code></td>
	<td class="value"><code><span class="php-quote">"log4php.rootLogger"</span></code></td>
	<td class="description"><div>
	<a href="#ROOT_LOGGER_PREFIX" class="anchor">#</a>

	<div class="description short">

	<p>Prefix used for defining the root logger.</p>

	</div>

	<div class="description detailed hidden">

	<p>Prefix used for defining the root logger.</p>


	</div>
	</div></td>
	</tr>
	<tr data-order="LOGGER_PREFIX" id="LOGGER_PREFIX">

	<td class="attributes"><code>string</code></td>
	<td class="name"><code>
	<a href="source-class-LoggerConfigurationAdapterINI.html#47-48" title="Go to source code"><b>LOGGER_PREFIX</b></a>
	</code></td>
	<td class="value"><code><span class="php-quote">"log4php.logger."</span></code></td>
	<td class="description"><div>
	<a href="#LOGGER_PREFIX" class="anchor">#</a>

	<div class="description short">

	<p>Prefix used for defining a logger.</p>

	</div>

	<div class="description detailed hidden">

	<p>Prefix used for defining a logger.</p>


	</div>
	</div></td>
	</tr>
	<tr data-order="APPENDER_PREFIX" id="APPENDER_PREFIX">

	<td class="attributes"><code>string</code></td>
	<td class="name"><code>
	<a href="source-class-LoggerConfigurationAdapterINI.html#50-51" title="Go to source code"><b>APPENDER_PREFIX</b></a>
	</code></td>
	<td class="value"><code><span class="php-quote">"log4php.appender."</span></code></td>
	<td class="description"><div>
	<a href="#APPENDER_PREFIX" class="anchor">#</a>

	<div class="description short">

	<p>Prefix used for defining an appender.</p>

	</div>

	<div class="description detailed hidden">

	<p>Prefix used for defining an appender.</p>


	</div>
	</div></td>
	</tr>
	<tr data-order="RENDERER_PREFIX" id="RENDERER_PREFIX">

	<td class="attributes"><code>string</code></td>
	<td class="name"><code>
	<a href="source-class-LoggerConfigurationAdapterINI.html#53-54" title="Go to source code"><b>RENDERER_PREFIX</b></a>
	</code></td>
	<td class="value"><code><span class="php-quote">"log4php.renderer."</span></code></td>
	<td class="description"><div>
	<a href="#RENDERER_PREFIX" class="anchor">#</a>

	<div class="description short">

	<p>Prefix used for defining a renderer.</p>

	</div>

	<div class="description detailed hidden">

	<p>Prefix used for defining a renderer.</p>


	</div>
	</div></td>
	</tr>
	</table>










	</div>

	<div id="footer">
	Apache log4php API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
	</div>
	</div>
	</div>
	</body>
	</html>