Added:
incubator/log4php/site/apidocs/log4php/appenders/LoggerAppen
derDb.html
URL: http://svn.apache.org/viewvc/incubator/log4php/s
ite/apidocs/log4php/appenders/LoggerAppenderDb.html?view=aut
o&rev=558223
============================================================
==================
---
incubator/log4php/site/apidocs/log4php/appenders/LoggerAppen
derDb.html (added)
+++
incubator/log4php/site/apidocs/log4php/appenders/LoggerAppen
derDb.html Fri Jul 20 19:10:17 2007
 -0,0
+1,645
+<?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-transiti
onal.dtd">
+ <html xmlns="http://www.w3.
org/1999/xhtml">
+ <head>
+ <!-- template designed by Marco Von Ballmoos -->
+ <title>Docs For Class
LoggerAppenderDb</title>
+ <link rel="stylesheet"
href="../../media/stylesheet.css" />
+ <meta http-equiv='Content-Type' content='text/html;
charset=iso-8859-1'/>
+ </head>
+ <body>
+ <div class="page-body">
+<h2 class="class-name">Class
LoggerAppenderDb</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>)
+
+ </div>
+ <div class="info-box-body">
+ <!-- ========== Info from phpDoc block
========= -->
+<p class="short-description">Appends log
events to a db table using PEAR: B
class.</p>
+<p class="description"><p>This
appender uses a table in a database to log
events.</p><p>Parameters are <a
href="../../log4php/appenders/LoggerAppenderDb.html#var
$dsn">$dsn</a>, <a
href="../../log4php/appenders/LoggerAppenderDb.html#var
$createTable">$createTable</a>, <a
href="../../log4php/appenders/LoggerAppenderDb.html#var
$table">table</a> and <a
href="../../log4php/appenders/LoggerAppenderDb.html#var
$sql">$sql</a>.</p><p>See examples
in test directory.</p><p></p></p>
+ <ul class="tags">
+ <li><span
class="field">author:</span> Marco
Vassura</li>
+ <li><span
class="field">version:</span> $Revision:
556784 $</li>
+ <li><span
class="field">since:</span>
0.3</li>
+ </ul>
+ <p class="notes">
+ Located in <a class="field"
href="_appenders---LoggerAppenderDb.php.html">/
appenders/LoggerAppenderDb.php</a> (line <span
class="field">36</span>)
+ </p>
+
+
+ <pre><a
href="../../log4php/LoggerAppender.html">Logger
Appender</a>
+ |
+ --<a
href="../../log4php/LoggerAppenderSkeleton.html"&g
t;LoggerAppenderSkeleton</a>
+ |
+ --LoggerAppenderDb</pre>
+
+ </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>)
+
+ </div>
+ <div class="info-box-body">
+ <div class="var-summary">
+ <div
class="var-title">
+ <span
class="var-type">boolean</span>
+ <a href="#$createTable"
title="details"
class="var-name">$createTable</a>
+ </div>
+ <div class="var-title">
+ <span
class="var-type">string</span>
+ <a href="#$dsn" title="details"
class="var-name">$dsn</a>
+ </div>
+ <div class="var-title">
+ <span
class="var-type">string</span>
+ <a href="#$sql" title="details"
class="var-name">$sql</a>
+ </div>
+ <div class="var-title">
+ <span
class="var-type">string</span>
+ <a href="#$table"
title="details"
class="var-name">$table</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-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">LoggerAppenderDb</span
>
+ <a href="#LoggerAppenderDb"
title="details"
class="method-name">LoggerAppenderDb</a>
+ (<span
class="var-type">string</span> &
lt;span class="var-name">$name</span>)
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">boolean</span>
+ <a href="#activateOptions"
title="details"
class="method-name">activateOptions</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#append"
title="details"
class="method-name">append</a>
+ (<span
class="var-type"></span> <spa
n class="var-name">$event</span>)
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#close"
title="details"
class="method-name">close</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">boolean</span>
+ <a href="#getCreateTable"
title="details"
class="method-name">getCreateTable</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">string</span>
+ <a href="#getDsn"
title="details"
class="method-name">getDsn</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">string</span>
+ <a href="#getSql"
title="details"
class="method-name">getSql</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">string</span>
+ <a href="#getTable"
title="details"
class="method-name">getTable</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#setCreateTable"
title="details"
class="method-name">setCreateTable</a>
+ (<span
class="var-type"></span> <spa
n class="var-name">$flag</span>)
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#setDsn"
title="details"
class="method-name">setDsn</a>
+ (<span
class="var-type"></span> <spa
n class="var-name">$newDsn</span>)
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#setSql"
title="details"
class="method-name">setSql</a>
+ (<span
class="var-type"></span> <spa
n class="var-name">$sql</span>)
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#setTable"
title="details"
class="method-name">setTable</a>
+ (<span
class="var-type"></span> <spa
n class="var-name">$table</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-method-summary">Methods</a>
(<a href="#sec-methods">details</a>)
+
+ </div>
+ <div class="info-box-body">
+ <a name="var$createTable"
id="$createTable"><!-- --></A>
+<div class="oddrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span
class="var-type">boolean</span>
+ <span
class="var-name">$createTable</span>
+ = <span class="var-default">
true</span> (line <span
class="line-number">42</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Create the log
table if it does not exists (optional).</p>
+
+
+
+
+
+</div>
+<a name="var$dsn"
id="$dsn"><!-- --></A>
+<div class="evenrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span
class="var-type">string</span>
+ <span
class="var-name">$dsn</span>
+ (line <span
class="line-number">48</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">PEAR:b Data
source name. Read PEAR:b for
dsn syntax (mandatory).</p>
+
+
+
+
+
+</div>
+<a name="var$sql"
id="$sql"><!-- --></A>
+<div class="oddrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span
class="var-type">string</span>
+ <span
class="var-name">$sql</span>
+ (line <span
class="line-number">54</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">A <a
href="../../log4php/layouts/LoggerPatternLayout.html&qu
ot;>LoggerPatternLayout</a> string used to format a
valid insert query (mandatory).</p>
+
+
+
+
+
+</div>
+<a name="var$table"
id="$table"><!-- --></A>
+<div class="evenrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span
class="var-type">string</span>
+ <span
class="var-name">$table</span>
+ (line <span
class="line-number">60</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Table name to
write events. Used only if $createTable is true.</p>
+
+
+
+
+
+</div>
+
<h4>Inherited Variables</h4>
+ <A NAME='inherited_vars'><!--
--></A>
+ <p>Inherited from <span
class="classname"><a
href="../../log4php/LoggerAppenderSkeleton.html"&g
t;LoggerAppenderSkeleton</a></span></p>
+ <blockquote>
+ <span class="var-title">
+ <span class="var-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#var$clo
sed">LoggerAppenderSkeleton::$closed</a></s
pan><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#var$err
orHandler">LoggerAppenderSkeleton::$errorHandler<
/a></span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#var$hea
dFilter">LoggerAppenderSkeleton::$headFilter</a&g
t;</span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#var$lay
out">LoggerAppenderSkeleton::$layout</a></s
pan><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#var$nam
e">LoggerAppenderSkeleton::$name</a></span&
gt;<br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#var$tai
lFilter">LoggerAppenderSkeleton::$tailFilter</a&g
t;</span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#var$thr
eshold">LoggerAppenderSkeleton::$threshold</a>
</span><br>
+ </span>
+ </blockquote>
+
+ </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-method-summary">Methods</a>
(<span
class="disabled">details</span>)
+
+ </div>
+ <div class="info-box-body">
+ <A NAME='method_detail'></A>
+
+<a name="methodLoggerAppenderDb"
id="LoggerAppenderDb"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">Constructor
LoggerAppenderDb</span> (line <span
class="line-number">84</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p
class="short-description">Constructor.</p>
;
+
+ <div class="method-signature">
+ <span
class="method-result">LoggerAppenderDb</span
>
+ <span class="method-name">
+ LoggerAppenderDb
+ </span>
+ (<span
class="var-type">string</span> &
lt;span class="var-name">$name</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span
class="var-type">string</span>
+ <span
class="var-name">$name</span><span
class="var-description">: appender
name</span> </li>
+ </ul>
+
+
+ </div>
+<a name="methodactivateOptions"
id="activateOptions"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">activateOptions</span&g
t; (line <span
class="line-number">95</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Setup db
connection.</p>
+<p class="description"><p>Based on
defined options, this method connects to db defined in <a
href="../../log4php/appenders/LoggerAppenderDb.html#var
$dsn">$dsn</a> and creates a <a
href="../../log4php/appenders/LoggerAppenderDb.html#var
$table">$table</a> table if <a
href="../../log4php/appenders/LoggerAppenderDb.html#var
$createTable">$createTable</a> is
true.</p></p>
+ <ul class="tags">
+ <li><span
class="field">return:</span> true if all
ok.</li>
+ </ul>
+
+ <div class="method-signature">
+ <span
class="method-result">boolean</span>
+ <span class="method-name">
+ activateOptions
+ </span>
+ ()
+ </div>
+
+
+ <hr class="separator" />
+ <div class="notes">Redefinition
of:</div>
+ <dl>
+ <dt><a
href="../../log4php/LoggerAppenderSkeleton.html#methoda
ctivateOptions">LoggerAppenderSkeleton::activateOpti
ons()</a></dt>
+ <dd>Derived appenders should override this
method if option structure requires it.</dd>
+ </dl>
+
+ </div>
+<a name="methodappend"
id="append"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">append</span> (line
<span class="line-number">131</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+
+ <div class="method-signature">
+ <span
class="method-result">void</span>
+ <span class="method-name">
+ append
+ </span>
+ (<span
class="var-type"></span> <spa
n class="var-name">$event</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type"></span>
+ <span
class="var-name">$event</span> </li&
gt;
+ </ul>
+
+ <hr class="separator" />
+ <div class="notes">Redefinition
of:</div>
+ <dl>
+ <dt><a
href="../../log4php/LoggerAppenderSkeleton.html#methoda
ppend">LoggerAppenderSkeleton::append()</a><
;/dt>
+ <dd>Subclasses of <a
href="../../log4php/LoggerAppenderSkeleton.html"&g
t;LoggerAppenderSkeleton</a> should implement this
method to perform actual logging.</dd>
+ </dl>
+
+ </div>
+<a name="methodclose"
id="close"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">close</span> (line
<span class="line-number">143</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+
+ <div class="method-signature">
+ <span
class="method-result">void</span>
+ <span class="method-name">
+ close
+ </span>
+ ()
+ </div>
+
+
+ <hr class="separator" />
+ <div class="notes">Redefinition
of:</div>
+ <dl>
+ <dt><a
href="../../log4php/LoggerAppender.html#methodclose&quo
t;>LoggerAppender::close()</a></dt>
+ <dd>Release any resources
allocated.</dd>
+ </dl>
+
+ </div>
+<a name="methodgetCreateTable"
id="getCreateTable"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">getCreateTable</span>
; (line <span
class="line-number">153</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+
+ <div class="method-signature">
+ <span
class="method-result">boolean</span>
+ <span class="method-name">
+ getCreateTable
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetDsn"
id="getDsn"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">getDsn</span> (line
<span class="line-number">161</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">return:</span> the defined
dsn</li>
+ </ul>
+
+ <div class="method-signature">
+ <span
class="method-result">string</span>
+ <span class="method-name">
+ getDsn
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetSql"
id="getSql"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">getSql</span> (line
<span class="line-number">169</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">return:</span> the sql
pattern string</li>
+ </ul>
+
+ <div class="method-signature">
+ <span
class="method-result">string</span>
+ <span class="method-name">
+ getSql
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetTable"
id="getTable"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">getTable</span>
(line <span
class="line-number">177</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">return:</span> the table
name to create</li>
+ </ul>
+
+ <div class="method-signature">
+ <span
class="method-result">string</span>
+ <span class="method-name">
+ getTable
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodsetCreateTable"
id="setCreateTable"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">setCreateTable</span>
; (line <span
class="line-number">182</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+
+ <div class="method-signature">
+ <span
class="method-result">void</span>
+ <span class="method-name">
+ setCreateTable
+ </span>
+ (<span
class="var-type"></span> <spa
n class="var-name">$flag</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type"></span>
+ <span
class="var-name">$flag</span> </li&g
t;
+ </ul>
+
+
+ </div>
+<a name="methodsetDsn"
id="setDsn"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">setDsn</span> (line
<span class="line-number">187</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+
+ <div class="method-signature">
+ <span
class="method-result">void</span>
+ <span class="method-name">
+ setDsn
+ </span>
+ (<span
class="var-type"></span> <spa
n class="var-name">$newDsn</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type"></span>
+ <span
class="var-name">$newDsn</span> </li
>
+ </ul>
+
+
+ </div>
+<a name="methodsetSql"
id="setSql"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">setSql</span> (line
<span class="line-number">192</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+
+ <div class="method-signature">
+ <span
class="method-result">void</span>
+ <span class="method-name">
+ setSql
+ </span>
+ (<span
class="var-type"></span> <spa
n class="var-name">$sql</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type"></span>
+ <span
class="var-name">$sql</span> </li>
;
+ </ul>
+
+
+ </div>
+<a name="methodsetTable"
id="setTable"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">setTable</span>
(line <span
class="line-number">197</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+
+ <div class="method-signature">
+ <span
class="method-result">void</span>
+ <span class="method-name">
+ setTable
+ </span>
+ (<span
class="var-type"></span> <spa
n class="var-name">$table</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type"></span>
+ <span
class="var-name">$table</span> </li&
gt;
+ </ul>
+
+
+ </div>
+ <h4>Inherited Methods</h4>
+ <a name='inherited_methods'><!--
--></a>
+ <!-- =========== Summary =========== -->
+ <p>Inherited From <span
class="classname"><a
href="../../log4php/LoggerAppenderSkeleton.html"&g
t;LoggerAppenderSkeleton</a></span></p>
+ <blockquote>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#method_
_construct">LoggerAppenderSkeleton::__construct()<
;/a></span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methoda
ctivateOptions">LoggerAppenderSkeleton::activateOpti
ons()</a></span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methoda
ddFilter">LoggerAppenderSkeleton::addFilter()</a&
gt;</span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methoda
ppend">LoggerAppenderSkeleton::append()</a><
;/span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methodc
learFilters">LoggerAppenderSkeleton::clearFilters()&
lt;/a></span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methodd
oAppend">LoggerAppenderSkeleton::doAppend()</a>
;</span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methodf
inalize">LoggerAppenderSkeleton::finalize()</a>
;</span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methodg
etErrorHandler">LoggerAppenderSkeleton::getErrorHand
ler()</a></span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methodg
etFilter">LoggerAppenderSkeleton::getFilter()</a&
gt;</span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methodg
etFirstFilter">LoggerAppenderSkeleton::getFirstFilte
r()</a></span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methodg
etLayout">LoggerAppenderSkeleton::getLayout()</a&
gt;</span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methodg
etName">LoggerAppenderSkeleton::getName()</a>&
lt;/span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methodg
etThreshold">LoggerAppenderSkeleton::getThreshold()&
lt;/a></span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methodi
sAsSevereAsThreshold">LoggerAppenderSkeleton::isAsSe
vereAsThreshold()</a></span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methodr
equiresLayout">LoggerAppenderSkeleton::requiresLayou
t()</a></span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methods
etErrorHandler">LoggerAppenderSkeleton::setErrorHand
ler()</a></span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methods
etLayout">LoggerAppenderSkeleton::setLayout()</a&
gt;</span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methods
etName">LoggerAppenderSkeleton::setName()</a>&
lt;/span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methods
etThreshold">LoggerAppenderSkeleton::setThreshold()&
lt;/a></span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#method_
_sleep">LoggerAppenderSkeleton::__sleep()</a>&
lt;/span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#method_
_wakeup">LoggerAppenderSkeleton::__wakeup()</a>
;</span><br>
+ </blockquote>
+ <!-- =========== Summary =========== -->
+ <p>Inherited From <span
class="classname"><a
href="../../log4php/LoggerAppender.html">Logger
Appender</a></span></p>
+ <blockquote>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppender.html#methodaddFilter
">LoggerAppender::addFilter()</a></span>
<br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppender.html#methodclearFilt
ers">LoggerAppender::clearFilters()</a></sp
an><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppender.html#methodclose&quo
t;>LoggerAppender::close()</a></span><br&g
t;
+ <span
class="method-name"><a
href="../../log4php/LoggerAppender.html#methoddoAppend&
quot;>LoggerAppender::doAppend()</a></span>&l
t;br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppender.html#methodfactory&q
uot;>LoggerAppender::factory()</a></span><
br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppender.html#methodgetErrorH
andler">LoggerAppender::getErrorHandler()</a>&
lt;/span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppender.html#methodgetFilter
">LoggerAppender::getFilter()</a></span>
<br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppender.html#methodgetLayout
">LoggerAppender::getLayout()</a></span>
<br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppender.html#methodgetName&q
uot;>LoggerAppender::getName()</a></span><
br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppender.html#methodrequiresL
ayout">LoggerAppender::requiresLayout()</a><
;/span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppender.html#methodsetErrorH
andler">LoggerAppender::setErrorHandler()</a>&
lt;/span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppender.html#methodsetLayout
">LoggerAppender::setLayout()</a></span>
<br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppender.html#methodsetName&q
uot;>LoggerAppender::setName()</a></span><
br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppender.html#methodsingleton
">LoggerAppender::singleton()</a></span>
<br>
+ </blockquote>
+
+ </div>
+ </div>
+
+
+ <p class="notes" id="credit">
+ Documentation generated on Fri, 20 Jul 2007 22:08:16
-0400 by <a href="http://www.phpdoc.org&quo
t; target="_blank">phpDocumentor
1.3.2</a>
+ </p>
+ </div></body>
+</html>
No newline at end of file
Added:
incubator/log4php/site/apidocs/log4php/appenders/LoggerAppen
derEcho.html
URL: http://svn.apache.org/viewvc/incubator/log4php
/site/apidocs/log4php/appenders/LoggerAppenderEcho.html?view
=auto&rev=558223
============================================================
==================
---
incubator/log4php/site/apidocs/log4php/appenders/LoggerAppen
derEcho.html (added)
+++
incubator/log4php/site/apidocs/log4php/appenders/LoggerAppen
derEcho.html Fri Jul 20 19:10:17 2007
-0,0
+1,272
+<?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-transiti
onal.dtd">
+ <html xmlns="http://www.w3.
org/1999/xhtml">
+ <head>
+ <!-- template designed by Marco Von Ballmoos -->
+ <title>Docs For Class
LoggerAppenderEcho</title>
+ <link rel="stylesheet"
href="../../media/stylesheet.css" />
+ <meta http-equiv='Content-Type' content='text/html;
charset=iso-8859-1'/>
+ </head>
+ <body>
+ <div class="page-body">
+<h2 class="class-name">Class
LoggerAppenderEcho</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-vars">Vars</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">LoggerAppenderEcho
uses <a href="http:
//www.php.net/echo">echo</a> function to
output events.</p>
+<p class="description"><p>This
appender requires a
layout.</p><p></p></p>
+ <ul class="tags">
+ <li><span
class="field">author:</span> Marco
Vassura</li>
+ <li><span
class="field">version:</span> $Revision:
556784 $</li>
+ </ul>
+ <p class="notes">
+ Located in <a class="field"
href="_appenders---LoggerAppenderEcho.php.html">
;/appenders/LoggerAppenderEcho.php</a> (line <span
class="field">33</span>)
+ </p>
+
+
+ <pre><a
href="../../log4php/LoggerAppender.html">Logger
Appender</a>
+ |
+ --<a
href="../../log4php/LoggerAppenderSkeleton.html"&g
t;LoggerAppenderSkeleton</a>
+ |
+ --LoggerAppenderEcho</pre>
+
+ </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-vars">Vars</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="#activateOptions"
title="details"
class="method-name">activateOptions</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#append"
title="details"
class="method-name">append</a>
+ (<span
class="var-type"></span> <spa
n class="var-name">$event</span>)
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#close"
title="details"
class="method-name">close</a>
+ ()
+ </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-method-summary">Methods</a>
(<a href="#sec-methods">details</a>)
+
+ </div>
+ <div class="info-box-body">
+
<h4>Inherited Variables</h4>
+ <A NAME='inherited_vars'><!--
--></A>
+ <p>Inherited from <span
class="classname"><a
href="../../log4php/LoggerAppenderSkeleton.html"&g
t;LoggerAppenderSkeleton</a></span></p>
+ <blockquote>
+ <span class="var-title">
+ <span class="var-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#var$clo
sed">LoggerAppenderSkeleton::$closed</a></s
pan><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#var$err
orHandler">LoggerAppenderSkeleton::$errorHandler<
/a></span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#var$hea
dFilter">LoggerAppenderSkeleton::$headFilter</a&g
t;</span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#var$lay
out">LoggerAppenderSkeleton::$layout</a></s
pan><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#var$nam
e">LoggerAppenderSkeleton::$name</a></span&
gt;<br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#var$tai
lFilter">LoggerAppenderSkeleton::$tailFilter</a&g
t;</span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#var$thr
eshold">LoggerAppenderSkeleton::$threshold</a>
</span><br>
+ </span>
+ </blockquote>
+
+ </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-vars">Vars</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="methodactivateOptions"
id="activateOptions"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">activateOptions</span&g
t; (line <span
class="line-number">46</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+
+ <div class="method-signature">
+ <span
class="method-result">void</span>
+ <span class="method-name">
+ activateOptions
+ </span>
+ ()
+ </div>
+
+
+ <hr class="separator" />
+ <div class="notes">Redefinition
of:</div>
+ <dl>
+ <dt><a
href="../../log4php/LoggerAppenderSkeleton.html#methoda
ctivateOptions">LoggerAppenderSkeleton::activateOpti
ons()</a></dt>
+ <dd>Derived appenders should override this
method if option structure requires it.</dd>
+ </dl>
+
+ </div>
+<a name="methodappend"
id="append"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">append</span> (line
<span class="line-number">59</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+
+ <div class="method-signature">
+ <span
class="method-result">void</span>
+ <span class="method-name">
+ append
+ </span>
+ (<span
class="var-type"></span> <spa
n class="var-name">$event</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type"></span>
+ <span
class="var-name">$event</span> </li&
gt;
+ </ul>
+
+ <hr class="separator" />
+ <div class="notes">Redefinition
of:</div>
+ <dl>
+ <dt><a
href="../../log4php/LoggerAppenderSkeleton.html#methoda
ppend">LoggerAppenderSkeleton::append()</a><
;/dt>
+ <dd>Subclasses of <a
href="../../log4php/LoggerAppenderSkeleton.html"&g
t;LoggerAppenderSkeleton</a> should implement this
method to perform actual logging.</dd>
+ </dl>
+
+ </div>
+<a name="methodclose"
id="close"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">close</span> (line
<span class="line-number">52</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+
+ <div class="method-signature">
+ <span
class="method-result">void</span>
+ <span class="method-name">
+ close
+ </span>
+ ()
+ </div>
+
+
+ <hr class="separator" />
+ <div class="notes">Redefinition
of:</div>
+ <dl>
+ <dt><a
href="../../log4php/LoggerAppender.html#methodclose&quo
t;>LoggerAppender::close()</a></dt>
+ <dd>Release any resources
allocated.</dd>
+ </dl>
+
+ </div>
+ <h4>Inherited Methods</h4>
+ <a name='inherited_methods'><!--
--></a>
+ <!-- =========== Summary =========== -->
+ <p>Inherited From <span
class="classname"><a
href="../../log4php/LoggerAppenderSkeleton.html"&g
t;LoggerAppenderSkeleton</a></span></p>
+ <blockquote>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#method_
_construct">LoggerAppenderSkeleton::__construct()<
;/a></span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methoda
ctivateOptions">LoggerAppenderSkeleton::activateOpti
ons()</a></span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methoda
ddFilter">LoggerAppenderSkeleton::addFilter()</a&
gt;</span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methoda
ppend">LoggerAppenderSkeleton::append()</a><
;/span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methodc
learFilters">LoggerAppenderSkeleton::clearFilters()&
lt;/a></span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methodd
oAppend">LoggerAppenderSkeleton::doAppend()</a>
;</span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methodf
inalize">LoggerAppenderSkeleton::finalize()</a>
;</span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methodg
etErrorHandler">LoggerAppenderSkeleton::getErrorHand
ler()</a></span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methodg
etFilter">LoggerAppenderSkeleton::getFilter()</a&
gt;</span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methodg
etFirstFilter">LoggerAppenderSkeleton::getFirstFilte
r()</a></span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methodg
etLayout">LoggerAppenderSkeleton::getLayout()</a&
gt;</span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methodg
etName">LoggerAppenderSkeleton::getName()</a>&
lt;/span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methodg
etThreshold">LoggerAppenderSkeleton::getThreshold()&
lt;/a></span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methodi
sAsSevereAsThreshold">LoggerAppenderSkeleton::isAsSe
vereAsThreshold()</a></span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methodr
equiresLayout">LoggerAppenderSkeleton::requiresLayou
t()</a></span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methods
etErrorHandler">LoggerAppenderSkeleton::setErrorHand
ler()</a></span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methods
etLayout">LoggerAppenderSkeleton::setLayout()</a&
gt;</span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methods
etName">LoggerAppenderSkeleton::setName()</a>&
lt;/span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methods
etThreshold">LoggerAppenderSkeleton::setThreshold()&
lt;/a></span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#method_
_sleep">LoggerAppenderSkeleton::__sleep()</a>&
lt;/span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#method_
_wakeup">LoggerAppenderSkeleton::__wakeup()</a>
;</span><br>
+ </blockquote>
+ <!-- =========== Summary =========== -->
+ <p>Inherited From <span
class="classname"><a
href="../../log4php/LoggerAppender.html">Logger
Appender</a></span></p>
+ <blockquote>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppender.html#methodaddFilter
">LoggerAppender::addFilter()</a></span>
<br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppender.html#methodclearFilt
ers">LoggerAppender::clearFilters()</a></sp
an><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppender.html#methodclose&quo
t;>LoggerAppender::close()</a></span><br&g
t;
+ <span
class="method-name"><a
href="../../log4php/LoggerAppender.html#methoddoAppend&
quot;>LoggerAppender::doAppend()</a></span>&l
t;br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppender.html#methodfactory&q
uot;>LoggerAppender::factory()</a></span><
br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppender.html#methodgetErrorH
andler">LoggerAppender::getErrorHandler()</a>&
lt;/span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppender.html#methodgetFilter
">LoggerAppender::getFilter()</a></span>
<br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppender.html#methodgetLayout
">LoggerAppender::getLayout()</a></span>
<br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppender.html#methodgetName&q
uot;>LoggerAppender::getName()</a></span><
br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppender.html#methodrequiresL
ayout">LoggerAppender::requiresLayout()</a><
;/span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppender.html#methodsetErrorH
andler">LoggerAppender::setErrorHandler()</a>&
lt;/span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppender.html#methodsetLayout
">LoggerAppender::setLayout()</a></span>
<br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppender.html#methodsetName&q
uot;>LoggerAppender::setName()</a></span><
br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppender.html#methodsingleton
">LoggerAppender::singleton()</a></span>
<br>
+ </blockquote>
+
+ </div>
+ </div>
+
+
+ <p class="notes" id="credit">
+ Documentation generated on Fri, 20 Jul 2007 22:08:16
-0400 by <a href="http://www.phpdoc.org&quo
t; target="_blank">phpDocumentor
1.3.2</a>
+ </p>
+ </div></body>
+</html>
No newline at end of file
Added:
incubator/log4php/site/apidocs/log4php/appenders/LoggerAppen
derFile.html
URL: http://svn.apache.org/viewvc/incubator/log4php
/site/apidocs/log4php/appenders/LoggerAppenderFile.html?view
=auto&rev=558223
============================================================
==================
---
incubator/log4php/site/apidocs/log4php/appenders/LoggerAppen
derFile.html (added)
+++
incubator/log4php/site/apidocs/log4php/appenders/LoggerAppen
derFile.html Fri Jul 20 19:10:17 2007
-0,0
+1,619
+<?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-transiti
onal.dtd">
+ <html xmlns="http://www.w3.
org/1999/xhtml">
+ <head>
+ <!-- template designed by Marco Von Ballmoos -->
+ <title>Docs For Class
LoggerAppenderFile</title>
+ <link rel="stylesheet"
href="../../media/stylesheet.css" />
+ <meta http-equiv='Content-Type' content='text/html;
charset=iso-8859-1'/>
+ </head>
+ <body>
+ <div class="page-body">
+<h2 class="class-name">Class
LoggerAppenderFile</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-vars">Vars</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">FileAppender
appends log events to a file.</p>
+<p class="description"><p>Parameters
are ($fileName but option name is
<strong>file</strong>),
$append.</p></p>
+ <ul class="tags">
+ <li><span
class="field">author:</span> Knut Urdalen
<<a href="mailto:knut.urdalengmail.com">knut.urdalengmail.com</a>></li>
+ <li><span
class="field">author:</span> Marco
Vassura</li>
+ <li><span
class="field">version:</span> $Revision:
556801 $</li>
+ </ul>
+ <p class="notes">
+ Located in <a class="field"
href="_appenders---LoggerAppenderFile.php.html">
;/appenders/LoggerAppenderFile.php</a> (line <span
class="field">34</span>)
+ </p>
+
+
+ <pre><a
href="../../log4php/LoggerAppender.html">Logger
Appender</a>
+ |
+ --<a
href="../../log4php/LoggerAppenderSkeleton.html"&g
t;LoggerAppenderSkeleton</a>
+ |
+ --LoggerAppenderFile</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-vars">Vars</a>
+ | <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&g
t;
+ </tr>
+ <tr>
+ <td style="padding-right: 2em"><a
href="../../log4php/appenders/LoggerAppenderRollingFile
.html">LoggerAppenderRollingFile</a></td>
;
+ <td>
+ LoggerAppenderRollingFile extends
LoggerAppenderFile to backup the log files when they reach a
certain size.
+ </td>
+ </tr>
+ <tr>
+ <td style="padding-right: 2em"><a
href="../../log4php/appenders/LoggerAppenderDailyFile.h
tml">LoggerAppenderDailyFile</a></td>
+ <td>
+ LoggerAppenderDailyFile appends log events to a
file ne.
+ </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>
|
+ <a
href="#sec-vars">Vars</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">LoggerAppenderFile</sp
an>
+ <a href="#__construct"
title="details"
class="method-name">__construct</a>
+ (<span
class="var-type"></span> <spa
n class="var-name">$name</span>)
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#activateOptions"
title="details"
class="method-name">activateOptions</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#append"
title="details"
class="method-name">append</a>
+ (<span
class="var-type"></span> <spa
n class="var-name">$event</span>)
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#close"
title="details"
class="method-name">close</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#closeFile"
title="details"
class="method-name">closeFile</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">boolean</span>
+ <a href="#getAppend"
title="details"
class="method-name">getAppend</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">string</span>
+ <a href="#getFile"
title="details"
class="method-name">getFile</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">string</span>
+ <a href="#getFileName"
title="details"
class="method-name">getFileName</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#reset"
title="details"
class="method-name">reset</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#setAppend"
title="details"
class="method-name">setAppend</a>
+ (<span
class="var-type"></span> <spa
n class="var-name">$flag</span>)
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#setFile"
title="details"
class="method-name">setFile</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#setFileName"
title="details"
class="method-name">setFileName</a>
+ (<span
class="var-type"></span> <spa
n class="var-name">$fileName</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-descendents">Descendents</a>
|
+ <a
href="#sec-var-summary">Vars</a>
(<span
class="disabled">details</span>)
+
+
+ |
+ <a
href="#sec-method-summary">Methods</a>
(<a href="#sec-methods">details</a>)
+
+ </div>
+ <div class="info-box-body">
+
<h4>Inherited Variables</h4>
+ <A NAME='inherited_vars'><!--
--></A>
+ <p>Inherited from <span
class="classname"><a
href="../../log4php/LoggerAppenderSkeleton.html"&g
t;LoggerAppenderSkeleton</a></span></p>
+ <blockquote>
+ <span class="var-title">
+ <span class="var-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#var$clo
sed">LoggerAppenderSkeleton::$closed</a></s
pan><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#var$err
orHandler">LoggerAppenderSkeleton::$errorHandler<
/a></span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#var$hea
dFilter">LoggerAppenderSkeleton::$headFilter</a&g
t;</span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#var$lay
out">LoggerAppenderSkeleton::$layout</a></s
pan><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#var$nam
e">LoggerAppenderSkeleton::$name</a></span&
gt;<br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#var$req
uiresLayout">LoggerAppenderSkeleton::$requiresLayout
</a></span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#var$tai
lFilter">LoggerAppenderSkeleton::$tailFilter</a&g
t;</span><br>
+ </span>
+ <span class="var-title">
+ <span class="var-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#var$thr
eshold">LoggerAppenderSkeleton::$threshold</a>
</span><br>
+ </span>
+ </blockquote>
+
+ </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-vars">Vars</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="method__construct"
id="__construct"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">Constructor
__construct</span> (line <span
class="line-number">49</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">LoggerAppenderFile</sp
an>
+ <span class="method-name">
+ __construct
+ </span>
+ (<span
class="var-type"></span> <spa
n class="var-name">$name</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type"></span>
+ <span
class="var-name">$name</span> </li&g
t;
+ </ul>
+
+ <hr class="separator" />
+ <div class="notes">Redefinition
of:</div>
+ <dl>
+ <dt><a
href="../../log4php/LoggerAppenderSkeleton.html#method_
_construct">LoggerAppenderSkeleton::__construct()<
;/a></dt>
+ <dd>Constructor</dd>
+ </dl>
+
+ </div>
+<a name="methodactivateOptions"
id="activateOptions"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">activateOptions</span&g
t; (line <span
class="line-number">54</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">
+ activateOptions
+ </span>
+ ()
+ </div>
+
+
+ <hr class="separator" />
+ <div class="notes">Redefinition
of:</div>
+ <dl>
+ <dt><a
href="../../log4php/LoggerAppenderSkeleton.html#methoda
ctivateOptions">LoggerAppenderSkeleton::activateOpti
ons()</a></dt>
+ <dd>Derived appenders should override this
method if option structure requires it.</dd>
+ </dl>
+
+ </div>
+<a name="methodappend"
id="append"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">append</span> (line
<span class="line-number">142</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">
+ append
+ </span>
+ (<span
class="var-type"></span> <spa
n class="var-name">$event</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type"></span>
+ <span
class="var-name">$event</span> </li&
gt;
+ </ul>
+
+ <hr class="separator" />
+ <div class="notes">Redefinition
of:</div>
+ <dl>
+ <dt><a
href="../../log4php/LoggerAppenderSkeleton.html#methoda
ppend">LoggerAppenderSkeleton::append()</a><
;/dt>
+ <dd>Subclasses of <a
href="../../log4php/LoggerAppenderSkeleton.html"&g
t;LoggerAppenderSkeleton</a> should implement this
method to perform actual logging.</dd>
+ </dl>
+
+ <hr class="separator" />
+ <div class="notes">Redefined in
descendants as:</div>
+ <ul class="redefinitions">
+ <li>
+ <a
href="../../log4php/appenders/LoggerAppenderRollingFile
.html#methodappend">LoggerAppenderRollingFile::appen
d()</a>
+ </li>
+ </ul>
+ </div>
+<a name="methodclose"
id="close"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">close</span> (line
<span class="line-number">68</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">
+ close
+ </span>
+ ()
+ </div>
+
+
+ <hr class="separator" />
+ <div class="notes">Redefinition
of:</div>
+ <dl>
+ <dt><a
href="../../log4php/LoggerAppender.html#methodclose&quo
t;>LoggerAppender::close()</a></dt>
+ <dd>Release any resources
allocated.</dd>
+ </dl>
+
+ </div>
+<a name="methodcloseFile"
id="closeFile"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">closeFile</span>
(line <span
class="line-number">80</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Closes the
previously opened file.</p>
+ <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">
+ closeFile
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetAppend"
id="getAppend"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">getAppend</span>
(line <span
class="line-number">88</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">boolean</span>
+ <span class="method-name">
+ getAppend
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetFile"
id="getFile"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">getFile</span> (line
<span class="line-number">95</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">string</span>
+ <span class="method-name">
+ getFile
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetFileName"
id="getFileName"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">getFileName</span>
(line <span
class="line-number">102</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">string</span>
+ <span class="method-name">
+ getFileName
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodreset"
id="reset"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">reset</span> (line
<span class="line-number">109</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Close any
previously opened file and call the parent's
reset.</p>
+ <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">
+ reset
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodsetAppend"
id="setAppend"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">setAppend</span>
(line <span
class="line-number">115</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">
+ setAppend
+ </span>
+ (<span
class="var-type"></span> <spa
n class="var-name">$flag</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type"></span>
+ <span
class="var-name">$flag</span> </li&g
t;
+ </ul>
+
+
+ </div>
+<a name="methodsetFile"
id="setFile"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">setFile</span> (line
<span class="line-number">126</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Sets and opens
the file where the log output will go.</p>
+<p class="description"><p>This is an
overloaded method. It can be called with:
<ul><li>setFile(string $fileName) to set
filename.</li><li>setFile(string $fileName,
boolean $append) to set filename and
append.</li></ul></p></p>
+ <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">
+ setFile
+ </span>
+ ()
+ </div>
+
+
+
+ <hr class="separator" />
+ <div class="notes">Redefined in
descendants as:</div>
+ <ul class="redefinitions">
+ <li>
+ <a
href="../../log4php/appenders/LoggerAppenderDailyFile.h
tml#methodsetFile">LoggerAppenderDailyFile::setFile(
)</a>
+ : The File property takes a string value which
should be the name of the file to append to.
+ </li>
+ </ul>
+ </div>
+<a name="methodsetFileName"
id="setFileName"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">setFileName</span>
(line <span
class="line-number">138</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">
+ setFileName
+ </span>
+ (<span
class="var-type"></span> <spa
n class="var-name">$fileName</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type"></span>
+ <span
class="var-name">$fileName</span> </
li>
+ </ul>
+
+
+ <hr class="separator" />
+ <div class="notes">Redefined in
descendants as:</div>
+ <ul class="redefinitions">
+ <li>
+ <a
href="../../log4php/appenders/LoggerAppenderRollingFile
.html#methodsetFileName">LoggerAppenderRollingFile::
setFileName()</a>
+ </li>
+ </ul>
+ </div>
+ <h4>Inherited Methods</h4>
+ <a name='inherited_methods'><!--
--></a>
+ <!-- =========== Summary =========== -->
+ <p>Inherited From <span
class="classname"><a
href="../../log4php/LoggerAppenderSkeleton.html"&g
t;LoggerAppenderSkeleton</a></span></p>
+ <blockquote>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#method_
_construct">LoggerAppenderSkeleton::__construct()<
;/a></span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methoda
ctivateOptions">LoggerAppenderSkeleton::activateOpti
ons()</a></span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methoda
ddFilter">LoggerAppenderSkeleton::addFilter()</a&
gt;</span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methoda
ppend">LoggerAppenderSkeleton::append()</a><
;/span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methodc
learFilters">LoggerAppenderSkeleton::clearFilters()&
lt;/a></span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methodd
oAppend">LoggerAppenderSkeleton::doAppend()</a>
;</span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methodf
inalize">LoggerAppenderSkeleton::finalize()</a>
;</span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methodg
etErrorHandler">LoggerAppenderSkeleton::getErrorHand
ler()</a></span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methodg
etFilter">LoggerAppenderSkeleton::getFilter()</a&
gt;</span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methodg
etFirstFilter">LoggerAppenderSkeleton::getFirstFilte
r()</a></span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methodg
etLayout">LoggerAppenderSkeleton::getLayout()</a&
gt;</span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methodg
etName">LoggerAppenderSkeleton::getName()</a>&
lt;/span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methodg
etThreshold">LoggerAppenderSkeleton::getThreshold()&
lt;/a></span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methodi
sAsSevereAsThreshold">LoggerAppenderSkeleton::isAsSe
vereAsThreshold()</a></span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methodr
equiresLayout">LoggerAppenderSkeleton::requiresLayou
t()</a></span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methods
etErrorHandler">LoggerAppenderSkeleton::setErrorHand
ler()</a></span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methods
etLayout">LoggerAppenderSkeleton::setLayout()</a&
gt;</span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methods
etName">LoggerAppenderSkeleton::setName()</a>&
lt;/span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#methods
etThreshold">LoggerAppenderSkeleton::setThreshold()&
lt;/a></span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#method_
_sleep">LoggerAppenderSkeleton::__sleep()</a>&
lt;/span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppenderSkeleton.html#method_
_wakeup">LoggerAppenderSkeleton::__wakeup()</a>
;</span><br>
+ </blockquote>
+ <!-- =========== Summary =========== -->
+ <p>Inherited From <span
class="classname"><a
href="../../log4php/LoggerAppender.html">Logger
Appender</a></span></p>
+ <blockquote>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppender.html#methodaddFilter
">LoggerAppender::addFilter()</a></span>
<br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppender.html#methodclearFilt
ers">LoggerAppender::clearFilters()</a></sp
an><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppender.html#methodclose&quo
t;>LoggerAppender::close()</a></span><br&g
t;
+ <span
class="method-name"><a
href="../../log4php/LoggerAppender.html#methoddoAppend&
quot;>LoggerAppender::doAppend()</a></span>&l
t;br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppender.html#methodfactory&q
uot;>LoggerAppender::factory()</a></span><
br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppender.html#methodgetErrorH
andler">LoggerAppender::getErrorHandler()</a>&
lt;/span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppender.html#methodgetFilter
">LoggerAppender::getFilter()</a></span>
<br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppender.html#methodgetLayout
">LoggerAppender::getLayout()</a></span>
<br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppender.html#methodgetName&q
uot;>LoggerAppender::getName()</a></span><
br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppender.html#methodrequiresL
ayout">LoggerAppender::requiresLayout()</a><
;/span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppender.html#methodsetErrorH
andler">LoggerAppender::setErrorHandler()</a>&
lt;/span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppender.html#methodsetLayout
">LoggerAppender::setLayout()</a></span>
<br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppender.html#methodsetName&q
uot;>LoggerAppender::setName()</a></span><
br>
+ <span
class="method-name"><a
href="../../log4php/LoggerAppender.html#methodsingleton
">LoggerAppender::singleton()</a></span>
<br>
+ </blockquote>
+
+ </div>
+ </div>
+
+
+ <p class="notes" id="credit">
+ Documentation generated on Fri, 20 Jul 2007 22:08:16
-0400 by <a href="http://www.phpdoc.org&quo
t; target="_blank">phpDocumentor
1.3.2</a>
+ </p>
+ </div></body>
+</html>
No newline at end of file
|
