Google Git
Sign in
apache / logging-site / a4f88a44f9ece0268ea2d36ba57a00f2b881cabc / . / content / log4php / 2.2.1 / apidocs / log4php / helpers / LoggerOptionConverter.html
blob: fc38d49cbaa5a0466002fabad4a5b051ae6dccf8 [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 LoggerOptionConverter</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 LoggerOptionConverter</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">A convenience class to convert property values to specific types.</p>
<ul class="tags">
<li><span class="field">version:</span> $Revision: 1237446 $</li>
<li><span class="field">since:</span> 0.5</li>
</ul>
<p class="notes">
Located in <a class="field" href="_helpers---LoggerOptionConverter.php.html">/helpers/LoggerOptionConverter.php</a> (line <span class="field">29</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="#DELIM_START" title="details" class="const-name">DELIM_START</a> = <span class="var-type"> '${'</span>
</div>
<div class="const-title">
<img src="../../media/images/Constant.png" alt=" " />
<a href="#DELIM_START_LEN" title="details" class="const-name">DELIM_START_LEN</a> = <span class="var-type"> 2</span>
</div>
<div class="const-title">
<img src="../../media/images/Constant.png" alt=" " />
<a href="#DELIM_STOP" title="details" class="const-name">DELIM_STOP</a> = <span class="var-type"> '}'</span>
</div>
<div class="const-title">
<img src="../../media/images/Constant.png" alt=" " />
<a href="#DELIM_STOP_LEN" title="details" class="const-name">DELIM_STOP_LEN</a> = <span class="var-type"> 1</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">
static <span class="var-type">mixed</span>
<a href="#$falseValues" title="details" class="var-name">$falseValues</a>
</div>
<div class="var-title">
static <span class="var-type">mixed</span>
<a href="#$trueValues" title="details" class="var-name">$trueValues</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">
static <span class="method-result">string</span>
<a href="#findAndSubst" title="details" class="method-name">findAndSubst</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$props</span>)
</div>
<div class="method-definition">
static <span class="method-result">string</span>
<a href="#getSystemProperty" title="details" class="method-name">getSystemProperty</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">$def</span>)
</div>
<div class="method-definition">
static <span class="method-result">string</span>
<a href="#substVars" title="details" class="method-name">substVars</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$val</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$props</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
static <span class="method-result">boolean</span>
<a href="#toBoolean" title="details" class="method-name">toBoolean</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$default</span> = <span class="var-default">true</span>])
</div>
<div class="method-definition">
static <span class="method-result">void</span>
<a href="#toBooleanEx" title="details" class="method-name">toBooleanEx</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
</div>
<div class="method-definition">
static <span class="method-result">float</span>
<a href="#toFileSize" title="details" class="method-name">toFileSize</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>, <span class="var-type">float</span>&nbsp;<span class="var-name">$default</span>)
</div>
<div class="method-definition">
static <span class="method-result">integer</span>
<a href="#toFileSizeEx" title="details" class="method-name">toFileSizeEx</a>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>)
</div>
<div class="method-definition">
static <span class="method-result">integer</span>
<a href="#toInt" title="details" class="method-name">toInt</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$default</span>)
</div>
<div class="method-definition">
static <span class="method-result">void</span>
<a href="#toIntegerEx" title="details" class="method-name">toIntegerEx</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
</div>
<div class="method-definition">
static <span class="method-result"><a href="../../log4php/LoggerLevel.html">LoggerLevel</a></span>
<a href="#toLevel" title="details" class="method-name">toLevel</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>, <span class="var-type"><a href="../../log4php/LoggerLevel.html">LoggerLevel</a></span>&nbsp;<span class="var-name">$defaultValue</span>)
</div>
<div class="method-definition">
static <span class="method-result">void</span>
<a href="#toLevelEx" title="details" class="method-name">toLevelEx</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
</div>
<div class="method-definition">
static <span class="method-result">void</span>
<a href="#toPositiveIntegerEx" title="details" class="method-name">toPositiveIntegerEx</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
</div>
<div class="method-definition">
static <span class="method-result">void</span>
<a href="#toStringEx" title="details" class="method-name">toStringEx</a>
(<span class="var-type"></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$falseValues" id="$falseValues"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
static <span class="var-type">mixed</span>
<span class="var-name">$falseValues</span>
= <span class="var-default">array('0', 'false', 'no', 'off', '')</span> (line <span class="line-number">46</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">String values which are converted to boolean FALSE.</p>
<p class="description"><p>Note that an empty string must convert to false, because parse_ini_file() which is used for parsing configuration converts the value _false_ to an empty string.</p></p>
<ul class="tags">
<li><span class="field">access:</span> private</li>
</ul>
</div>
<a name="var$trueValues" id="$trueValues"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
static <span class="var-type">mixed</span>
<span class="var-name">$trueValues</span>
= <span class="var-default">array('1', 'true', 'yes', 'on')</span> (line <span class="line-number">37</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">String values which are converted to boolean TRUE.</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="methodfindAndSubst" id="findAndSubst"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static findAndSubst</span> (line <span class="line-number">350</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Find the value corresponding to <var>$key</var> in <var>$props</var>. Then perform variable substitution on the found value.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static <span class="method-result">string</span>
<span class="method-name">
findAndSubst
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$props</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$key</span> </li>
<li>
<span class="var-type">array</span>
<span class="var-name">$props</span> </li>
</ul>
</div>
<a name="methodgetSystemProperty" id="getSystemProperty"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">static getSystemProperty</span> (line <span class="line-number">61</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Read a predefined var.</p>
<p class="description"><p>It returns a value referenced by <var>$key</var> using this search criteria: <ul><li>if <var>$key</var> is a constant then return it. Else</li><li>if <var>$key</var> is set in <var>$_ENV</var> then return it. Else</li><li>return <var>$def</var>.</li></ul></p></p>
<ul class="tags">
<li><span class="field">return:</span> the string value of the system property, or the default value if there is no property with that key.</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static <span class="method-result">string</span>
<span class="method-name">
getSystemProperty
</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">$def</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$key</span><span class="var-description">: The key to search for.</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$def</span><span class="var-description">: The default value to return.</span> </li>
</ul>
</div>
<a name="methodsubstVars" id="substVars"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static substVars</span> (line <span class="line-number">406</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Perform variable substitution in string <var>$val</var> from the values of keys found with the getSystemProperty() method.</p>
<p class="description"><p>The variable substitution delimeters are <strong>${</strong> and <strong>}</strong>.</p><p>For example, if the &quot;MY_CONSTANT&quot; contains &quot;value&quot;, then the call <div class="src-code"><ol><li><div class="src-line">&nbsp;<span class="src-var">$s&nbsp;</span>=&nbsp;<span class="src-id"><a href="../../log4php/helpers/LoggerOptionConverter.html">LoggerOptionConverter</a></span><span class="src-sym">::</span><a href="../../log4php/helpers/LoggerOptionConverter.html#methodsubstVars">substVars</a><span class="src-sym">(</span><span class="src-str">&quot;</span><span class="src-str">Value&nbsp;of&nbsp;key&nbsp;is&nbsp;${<span class="src-str">MY_CONSTANT</span><span class="src-sym">}</span>.</span><span class="src-str">&quot;</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
</ol></div> will set the variable <em>$s</em> to &quot;Value of key is value.&quot;.</p><p>If no value could be found for the specified key, then the <var>$props</var> parameter is searched, if the value could not be found there, then substitution defaults to the empty string.</p><p>For example, if <a href="../../log4php/helpers/LoggerOptionConverter.html#methodgetSystemProperty">getSystemProperty()</a> cannot find any value for the key &quot;inexistentKey&quot;, then the call <div class="src-code"><ol><li><div class="src-line">&nbsp;<span class="src-var">$s&nbsp;</span>=&nbsp;<span class="src-id"><a href="../../log4php/helpers/LoggerOptionConverter.html">LoggerOptionConverter</a></span><span class="src-sym">::</span><a href="../../log4php/helpers/LoggerOptionConverter.html#methodsubstVars">substVars</a><span class="src-sym">(</span><span class="src-str">&quot;</span><span class="src-str">Value&nbsp;of&nbsp;inexistentKey&nbsp;is&nbsp;[${<span class="src-str">inexistentKey</span><span class="src-sym">}</span>]</span><span class="src-str">&quot;</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
</ol></div> will set <var>$s</var> to &quot;Value of inexistentKey is []&quot;.</p><p>A warn is thrown if <var>$val</var> contains a start delimeter &quot;${&quot; which is not balanced by a stop delimeter &quot;}&quot; and an empty string is returned.</p><p></p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static <span class="method-result">string</span>
<span class="method-name">
substVars
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$val</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$props</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$val</span><span class="var-description">: The string on which variable substitution is performed.</span> </li>
<li>
<span class="var-type">array</span>
<span class="var-name">$props</span> </li>
</ul>
</div>
<a name="methodtoBoolean" id="toBoolean"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">static toBoolean</span> (line <span class="line-number">85</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">If <var>$value</var> is <em>true</em>, then <em>true</em> is returned. If <var>$value</var> is <em>false</em>, then <em>true</em> is returned. Otherwise, <var>$default</var> is returned.</p>
<p class="description"><p>Case of value is unimportant.</p><p></p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static <span class="method-result">boolean</span>
<span class="method-name">
toBoolean
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$default</span> = <span class="var-default">true</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$value</span> </li>
<li>
<span class="var-type">boolean</span>
<span class="var-name">$default</span> </li>
</ul>
</div>
<a name="methodtoBooleanEx" id="toBooleanEx"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static toBooleanEx</span> (line <span class="line-number">105</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Converts $value to boolean, or throws an exception if not possible.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static <span class="method-result">void</span>
<span class="method-name">
toBooleanEx
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$value</span> </li>
</ul>
</div>
<a name="methodtoFileSize" id="toFileSize"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">static toFileSize</span> (line <span class="line-number">246</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static <span class="method-result">float</span>
<span class="method-name">
toFileSize
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>, <span class="var-type">float</span>&nbsp;<span class="var-name">$default</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$value</span> </li>
<li>
<span class="var-type">float</span>
<span class="var-name">$default</span> </li>
</ul>
</div>
<a name="methodtoFileSizeEx" id="toFileSizeEx"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static toFileSizeEx</span> (line <span class="line-number">286</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Converts a value to a valid file size (integer).</p>
<p class="description"><p>Supports 'KB', 'MB' and 'GB' suffixes, where KB = 1024 B etc.</p><p>The final value will be rounded to the nearest integer.</p><p>Examples: <ul><li>'100' =&gt; 100</li><li>'100.12' =&gt; 100</li><li>'100KB' =&gt; 102400</li><li>'1.5MB' =&gt; 1572864</li></ul></p></p>
<ul class="tags">
<li><span class="field">return:</span> Parsed file size.</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static <span class="method-result">integer</span>
<span class="method-name">
toFileSizeEx
</span>
(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">mixed</span>
<span class="var-name">$value</span><span class="var-description">: File size (optionally with suffix).</span> </li>
</ul>
</div>
<a name="methodtoInt" id="toInt"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">static toInt</span> (line <span class="line-number">127</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static <span class="method-result">integer</span>
<span class="method-name">
toInt
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$default</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$value</span> </li>
<li>
<span class="var-type">integer</span>
<span class="var-name">$default</span> </li>
</ul>
</div>
<a name="methodtoIntegerEx" id="toIntegerEx"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static toIntegerEx</span> (line <span class="line-number">141</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Converts $value to integer, or throws an exception if not possible.</p>
<p class="description"><p>Floats cannot be converted to integer.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static <span class="method-result">void</span>
<span class="method-name">
toIntegerEx
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$value</span> </li>
</ul>
</div>
<a name="methodtoLevel" id="toLevel"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">static toLevel</span> (line <span class="line-number">193</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Converts a standard or custom priority level to a Level object.</p>
<p class="description"><p>If <var>$value</var> is of form &quot;<strong>level#full_file_classname</strong>&quot;, where <em>full_file_classname</em> means the class filename with path but without php extension, then the specified class' <em>toLevel()</em> method is called to process the specified level string; if no '#' character is present, then the default <a href="../../log4php/LoggerLevel.html">LoggerLevel</a> class is used to process the level value.</p><p>As a special case, if the <var>$value</var> parameter is equal to the string &quot;NULL&quot;, then the value <em>null</em> will be returned.</p><p>If any error occurs while converting the value to a level, the <var>$defaultValue</var> parameter, which may be <em>null</em>, is returned.</p><p>Case of <var>$value</var> is insignificant for the level level, but is significant for the class name part, if present.</p><p></p></p>
<ul class="tags">
<li><span class="field">return:</span> a <a href="../../log4php/LoggerLevel.html">LoggerLevel</a> or null</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static <span class="method-result"><a href="../../log4php/LoggerLevel.html">LoggerLevel</a></span>
<span class="method-name">
toLevel
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>, <span class="var-type"><a href="../../log4php/LoggerLevel.html">LoggerLevel</a></span>&nbsp;<span class="var-name">$defaultValue</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$value</span> </li>
<li>
<span class="var-type"><a href="../../log4php/LoggerLevel.html">LoggerLevel</a></span>
<span class="var-name">$defaultValue</span> </li>
</ul>
</div>
<a name="methodtoLevelEx" id="toLevelEx"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static toLevelEx</span> (line <span class="line-number">230</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Converts the value to a level. Throws an exception if not possible.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static <span class="method-result">void</span>
<span class="method-name">
toLevelEx
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$value</span> </li>
</ul>
</div>
<a name="methodtoPositiveIntegerEx" id="toPositiveIntegerEx"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">static toPositiveIntegerEx</span> (line <span class="line-number">156</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Converts $value to integer, or throws an exception if not possible.</p>
<p class="description"><p>Floats cannot be converted to integer.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static <span class="method-result">void</span>
<span class="method-name">
toPositiveIntegerEx
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$value</span> </li>
</ul>
</div>
<a name="methodtoStringEx" id="toStringEx"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static toStringEx</span> (line <span class="line-number">326</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Converts a value to string, or throws an exception if not possible.</p>
<p class="description"><p>Objects can be converted to string if they implement the magic __toString() method.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static <span class="method-result">void</span>
<span class="method-name">
toStringEx
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$value</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="constDELIM_START" id="DELIM_START"><!-- --></A>
<div class="oddrow">
<div class="const-header">
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">DELIM_START</span>
= <span class="const-default"> '${'</span>
(line <span class="line-number">31</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="constDELIM_START_LEN" id="DELIM_START_LEN"><!-- --></A>
<div class="evenrow">
<div class="const-header">
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">DELIM_START_LEN</span>
= <span class="const-default"> 2</span>
(line <span class="line-number">33</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="constDELIM_STOP" id="DELIM_STOP"><!-- --></A>
<div class="oddrow">
<div class="const-header">
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">DELIM_STOP</span>
= <span class="const-default"> '}'</span>
(line <span class="line-number">32</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="constDELIM_STOP_LEN" id="DELIM_STOP_LEN"><!-- --></A>
<div class="evenrow">
<div class="const-header">
<img src="../../media/images/Variable.png" />
<span class="const-title">
<span class="const-name">DELIM_STOP_LEN</span>
= <span class="const-default"> 1</span>
(line <span class="line-number">34</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Sat, 18 Feb 2012 22:32:26 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>