Google Git
Sign in
apache / logging-site / a4f88a44f9ece0268ea2d36ba57a00f2b881cabc / . / content / log4php / 2.2.1 / apidocs / log4php / LoggerConfigurable.html
blob: 38f1714d26dd0f37230403b72b52a230f4c41e20 [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 LoggerConfigurable</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 LoggerConfigurable</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-descendents">Descendents</a>
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">A base class from which all classes which have configurable properties are extended. Provides a generic setter with integrated validation.</p>
<ul class="tags">
<li><span class="field">version:</span> $Revision $</li>
<li><span class="field">abstract:</span> </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="_LoggerConfigurable.php.html">/LoggerConfigurable.php</a> (line <span class="field">30</span>)
</p>
<pre></pre>
</div>
</div>
<a name="sec-descendents"></a>
<div class="info-box">
<div class="info-box-title">Direct descendents</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Descendents</span>
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<table cellpadding="2" cellspacing="0" class="class-table">
<tr>
<th class="class-table-header">Class</th>
<th class="class-table-header">Description</th>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../log4php/LoggerAppender.html">LoggerAppender</a></td>
<td>
Abstract class that defines output logs strategies.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../log4php/LoggerLayout.html">LoggerLayout</a></td>
<td>
Extend this abstract class to create your own log layout format.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../log4php/LoggerFilter.html">LoggerFilter</a></td>
<td>
Users should extend this class to implement customized logging
</td>
</tr>
</table>
</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-descendents">Descendents</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="#setBoolean" title="details" class="method-name">setBoolean</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$property</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setFileSize" title="details" class="method-name">setFileSize</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$property</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setInteger" title="details" class="method-name">setInteger</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$property</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setLevel" title="details" class="method-name">setLevel</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$property</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setNumeric" title="details" class="method-name">setNumeric</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$property</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setPositiveInteger" title="details" class="method-name">setPositiveInteger</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$property</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setString" title="details" class="method-name">setString</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$property</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$value</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$nullable</span> = <span class="var-default">false</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-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-descendents">Descendents</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="methodsetBoolean" id="setBoolean"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">setBoolean</span> (line <span class="line-number">33</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Setter function for boolean type.</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
setBoolean
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$property</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">$property</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$value</span> </li>
</ul>
</div>
<a name="methodsetFileSize" id="setFileSize"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">setFileSize</span> (line <span class="line-number">73</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Setter for file size.</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
setFileSize
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$property</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">$property</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$value</span> </li>
</ul>
</div>
<a name="methodsetInteger" id="setInteger"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">setInteger</span> (line <span class="line-number">43</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Setter function for integer type.</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
setInteger
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$property</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">$property</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$value</span> </li>
</ul>
</div>
<a name="methodsetLevel" id="setLevel"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">setLevel</span> (line <span class="line-number">53</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Setter function for LoggerLevel values.</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
setLevel
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$property</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">$property</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$value</span> </li>
</ul>
</div>
<a name="methodsetNumeric" id="setNumeric"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">setNumeric</span> (line <span class="line-number">83</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Setter function for numeric type.</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
setNumeric
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$property</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">$property</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$value</span> </li>
</ul>
</div>
<a name="methodsetPositiveInteger" id="setPositiveInteger"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">setPositiveInteger</span> (line <span class="line-number">63</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Setter function for integer type.</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
setPositiveInteger
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$property</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">$property</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$value</span> </li>
</ul>
</div>
<a name="methodsetString" id="setString"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">setString</span> (line <span class="line-number">93</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Setter function for string type.</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
setString
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$property</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$value</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$nullable</span> = <span class="var-default">false</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$property</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$value</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$nullable</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">111</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Triggers a warning.</p>
<ul class="tags">
<li><span class="field">access:</span> protected</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>
<hr class="separator" />
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../log4php/LoggerAppender.html#methodwarn">LoggerAppender::warn()</a>
: Triggers a warning for this logger with the given message.
</li>
<li>
<a href="../log4php/LoggerLayout.html#methodwarn">LoggerLayout::warn()</a>
: Triggers a warning for this layout with the given message.
</li>
</ul>
</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>