Added:
incubator/log4php/site/apidocs/log4php/appenders/LoggerAppen
derMail.html
URL: http://svn.apache.org/viewvc/incubator/log4php
/site/apidocs/log4php/appenders/LoggerAppenderMail.html?view
=auto&rev=558223
============================================================
==================
---
incubator/log4php/site/apidocs/log4php/appenders/LoggerAppen
derMail.html (added)
+++
incubator/log4php/site/apidocs/log4php/appenders/LoggerAppen
derMail.html Fri Jul 20 19:10:17 2007
 -0,0
+1,576 
+<?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
LoggerAppenderMail</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
LoggerAppenderMail</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 mail using php function <a href="http://www.php.net/mail">ht
tp://www.php.net/mail</a>.</p>
+<p class="description"><p>Parameters
are <a
href="../../log4php/appenders/LoggerAppenderMail.html#v
ar$from">$from</a>, <a
href="../../log4php/appenders/LoggerAppenderMail.html#v
ar$to">$to</a>, <a
href="../../log4php/appenders/LoggerAppenderMail.html#v
ar$subject">$subject</a>.</p><p>Th
is 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:
556801 $</li>
+ </ul>
+ <p class="notes">
+ Located in <a class="field"
href="_appenders---LoggerAppenderMail.php.html">
;/appenders/LoggerAppenderMail.php</a> (line <span
class="field">32</span>)
+ </p>
+
+
+ <pre><a
href="../../log4php/LoggerAppender.html">Logger
Appender</a>
+ |
+ --<a
href="../../log4php/LoggerAppenderSkeleton.html"&g
t;LoggerAppenderSkeleton</a>
+ |
+ --LoggerAppenderMail</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">string</span>
+ <a href="#$from"
title="details"
class="var-name">$from</a>
+ </div>
+ <div class="var-title">
+ <span
class="var-type">string</span>
+ <a href="#$subject"
title="details"
class="var-name">$subject</a>
+ </div>
+ <div class="var-title">
+ <span
class="var-type">string</span>
+ <a href="#$to" title="details"
class="var-name">$to</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">LoggerAppenderMail</sp
an>
+ <a href="#__construct"
title="details"
class="method-name">__construct</a>
+ (<span
class="var-type">string</span> &
lt;span 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">string</span>
+ <a href="#getFrom"
title="details"
class="method-name">getFrom</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">string</span>
+ <a href="#getSubject"
title="details"
class="method-name">getSubject</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">string</span>
+ <a href="#getTo"
title="details"
class="method-name">getTo</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#setFrom"
title="details"
class="method-name">setFrom</a>
+ (<span
class="var-type"></span> <spa
n class="var-name">$from</span>)
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#setSubject"
title="details"
class="method-name">setSubject</a>
+ (<span
class="var-type"></span> <spa
n class="var-name">$subject</span>)
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#setTo"
title="details"
class="method-name">setTo</a>
+ (<span
class="var-type"></span> <spa
n class="var-name">$to</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$from"
id="$from"><!-- --></A>
+<div class="oddrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span
class="var-type">string</span>
+ <span
class="var-name">$from</span>
+ = <span class="var-default">
null</span> (line <span
class="line-number">37</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">var:</span> 'from'
field</li>
+ </ul>
+
+
+
+
+
+</div>
+<a name="var$subject"
id="$subject"><!-- --></A>
+<div class="evenrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span
class="var-type">string</span>
+ <span
class="var-name">$subject</span>
+ = <span class="var-default"> 'Log4php
Report'</span> (line <span
class="line-number">42</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">var:</span> 'subject'
field</li>
+ </ul>
+
+
+
+
+
+</div>
+<a name="var$to" id="$to"><!--
--></A>
+<div class="oddrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span
class="var-type">string</span>
+ <span class="var-name">$to</span>
+ = <span class="var-default">
null</span> (line <span
class="line-number">47</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">var:</span> 'to'
field</li>
+ </ul>
+
+
+
+
+
+</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$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-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="method__construct"
id="__construct"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">Constructor
__construct</span> (line <span
class="line-number">60</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p
class="short-description">Constructor.</p>
;
+ <ul class="tags">
+ <li><span
class="field">access:</span>
public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span
class="method-result">LoggerAppenderMail</sp
an>
+ <span class="method-name">
+ __construct
+ </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>
+
+ <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">65</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">124</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">69</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="methodgetFrom"
id="getFrom"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">getFrom</span> (line
<span class="line-number">88</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+
+ <div class="method-signature">
+ <span
class="method-result">string</span>
+ <span class="method-name">
+ getFrom
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetSubject"
id="getSubject"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">getSubject</span>
(line <span
class="line-number">96</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+
+ <div class="method-signature">
+ <span
class="method-result">string</span>
+ <span class="method-name">
+ getSubject
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetTo"
id="getTo"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">getTo</span> (line
<span class="line-number">104</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+
+ <div class="method-signature">
+ <span
class="method-result">string</span>
+ <span class="method-name">
+ getTo
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodsetFrom"
id="setFrom"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">setFrom</span> (line
<span class="line-number">119</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+
+ <div class="method-signature">
+ <span
class="method-result">void</span>
+ <span class="method-name">
+ setFrom
+ </span>
+ (<span
class="var-type"></span> <spa
n class="var-name">$from</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type"></span>
+ <span
class="var-name">$from</span> </li&g
t;
+ </ul>
+
+
+ </div>
+<a name="methodsetSubject"
id="setSubject"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">setSubject</span>
(line <span
class="line-number">109</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+
+ <div class="method-signature">
+ <span
class="method-result">void</span>
+ <span class="method-name">
+ setSubject
+ </span>
+ (<span
class="var-type"></span> <spa
n class="var-name">$subject</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type"></span>
+ <span
class="var-name">$subject</span> </l
i>
+ </ul>
+
+
+ </div>
+<a name="methodsetTo"
id="setTo"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">setTo</span> (line
<span class="line-number">114</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+
+ <div class="method-signature">
+ <span
class="method-result">void</span>
+ <span class="method-name">
+ setTo
+ </span>
+ (<span
class="var-type"></span> <spa
n class="var-name">$to</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type"></span>
+ <span
class="var-name">$to</span> </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
Added:
incubator/log4php/site/apidocs/log4php/appenders/LoggerAppen
derMailEvent.html
URL: http://svn.apache.org/viewvc/incubator/lo
g4php/site/apidocs/log4php/appenders/LoggerAppenderMailEvent
.html?view=auto&rev=558223
============================================================
==================
---
incubator/log4php/site/apidocs/log4php/appenders/LoggerAppen
derMailEvent.html (added)
+++
incubator/log4php/site/apidocs/log4php/appenders/LoggerAppen
derMailEvent.html Fri Jul 20 19:10:17 2007
 -0,0
+1,719 
+<?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
LoggerAppenderMailEvent</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
LoggerAppenderMailEvent</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">Log events to
an email address. It will be created an email for each
event.</p>
+<p class="description"><p>Parameters
are <a
href="../../log4php/appenders/LoggerAppenderMailEvent.h
tml#var$smtpHost">$smtpHost</a> (optional),
<a
href="../../log4php/appenders/LoggerAppenderMailEvent.h
tml#var$port">$port</a> (optional), <a
href="../../log4php/appenders/LoggerAppenderMailEvent.h
tml#var$from">$from</a> (optional), <a
href="../../log4php/appenders/LoggerAppenderMailEvent.h
tml#var$to">$to</a>, <a
href="../../log4php/appenders/LoggerAppenderMailEvent.h
tml#var$subject">$subject</a>
(optional).</p><p>A layout is
required.</p><p></p></p>
+ <ul class="tags">
+ <li><span
class="field">author:</span> Marco
Vassura</li>
+ <li><span
class="field">author:</span> Domenico
Lordi <<a href="mailto:lordi interfree.it">lordi interfree.it</a>></li>
+ <li><span
class="field">version:</span> $Revision:
556784 $</li>
+ </ul>
+ <p class="notes">
+ Located in <a class="field"
href="_appenders---LoggerAppenderMailEvent.php.html&quo
t;>/appenders/LoggerAppenderMailEvent.php</a> (line
<span class="field">40</span>)
+ </p>
+
+
+ <pre><a
href="../../log4php/LoggerAppender.html">Logger
Appender</a>
+ |
+ --<a
href="../../log4php/LoggerAppenderSkeleton.html"&g
t;LoggerAppenderSkeleton</a>
+ |
+ --LoggerAppenderMailEvent</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">string</span>
+ <a href="#$from"
title="details"
class="var-name">$from</a>
+ </div>
+ <div class="var-title">
+ <span
class="var-type">integer</span>
+ <a href="#$port"
title="details"
class="var-name">$port</a>
+ </div>
+ <div class="var-title">
+ <span
class="var-type">string</span>
+ <a href="#$smtpHost"
title="details"
class="var-name">$smtpHost</a>
+ </div>
+ <div class="var-title">
+ <span
class="var-type">string</span>
+ <a href="#$subject"
title="details"
class="var-name">$subject</a>
+ </div>
+ <div class="var-title">
+ <span
class="var-type">string</span>
+ <a href="#$to" title="details"
class="var-name">$to</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">LoggerAppenderMailEvent&l
t;/span>
+ <a href="#LoggerAppenderMailEvent"
title="details"
class="method-name">LoggerAppenderMailEvent<
/a>
+ (<span
class="var-type">string</span> &
lt;span 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">string</span>
+ <a href="#getFrom"
title="details"
class="method-name">getFrom</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">integer</span>
+ <a href="#getPort"
title="details"
class="method-name">getPort</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">string</span>
+ <a href="#getSmtpHost"
title="details"
class="method-name">getSmtpHost</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">string</span>
+ <a href="#getSubject"
title="details"
class="method-name">getSubject</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">string</span>
+ <a href="#getTo"
title="details"
class="method-name">getTo</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#setFrom"
title="details"
class="method-name">setFrom</a>
+ (<span
class="var-type"></span> <spa
n class="var-name">$from</span>)
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#setPort"
title="details"
class="method-name">setPort</a>
+ (<span
class="var-type"></span> <spa
n class="var-name">$port</span>)
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#setSmtpHost"
title="details"
class="method-name">setSmtpHost</a>
+ (<span
class="var-type"></span> <spa
n class="var-name">$smtpHost</span>)
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#setSubject"
title="details"
class="method-name">setSubject</a>
+ (<span
class="var-type"></span> <spa
n class="var-name">$subject</span>)
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#setTo"
title="details"
class="method-name">setTo</a>
+ (<span
class="var-type"></span> <spa
n class="var-name">$to</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$from"
id="$from"><!-- --></A>
+<div class="evenrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span
class="var-type">string</span>
+ <span
class="var-name">$from</span>
+ = <span class="var-default">
null</span> (line <span
class="line-number">45</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">var:</span> 'from'
field</li>
+ </ul>
+
+
+
+
+
+</div>
+<a name="var$port"
id="$port"><!-- --></A>
+<div class="oddrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span
class="var-type">integer</span>
+ <span
class="var-name">$port</span>
+ = <span class="var-default">
25</span> (line <span
class="line-number">50</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">var:</span> 'from'
field</li>
+ </ul>
+
+
+
+
+
+</div>
+<a name="var$smtpHost"
id="$smtpHost"><!-- --></A>
+<div class="evenrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span
class="var-type">string</span>
+ <span
class="var-name">$smtpHost</span>
+ = <span class="var-default">
null</span> (line <span
class="line-number">55</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">var:</span>
hostname.</li>
+ </ul>
+
+
+
+
+
+</div>
+<a name="var$subject"
id="$subject"><!-- --></A>
+<div class="oddrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span
class="var-type">string</span>
+ <span
class="var-name">$subject</span>
+ = <span class="var-default">
''</span> (line <span
class="line-number">60</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">var:</span> 'subject'
field</li>
+ </ul>
+
+
+
+
+
+</div>
+<a name="var$to" id="$to"><!--
--></A>
+<div class="evenrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span
class="var-type">string</span>
+ <span class="var-name">$to</span>
+ = <span class="var-default">
null</span> (line <span
class="line-number">65</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">var:</span> 'to'
field</li>
+ </ul>
+
+
+
+
+
+</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="methodLoggerAppenderMailEvent"
id="LoggerAppenderMailEvent"><!--
--></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">Constructor
LoggerAppenderMailEvent</span> (line <span
class="line-number">77</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p
class="short-description">Constructor.</p>
;
+
+ <div class="method-signature">
+ <span
class="method-result">LoggerAppenderMailEvent&l
t;/span>
+ <span class="method-name">
+ LoggerAppenderMailEvent
+ </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">82</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="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">append</span> (line
<span class="line-number">123</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">87</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="methodgetFrom"
id="getFrom"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">getFrom</span> (line
<span class="line-number">95</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+
+ <div class="method-signature">
+ <span
class="method-result">string</span>
+ <span class="method-name">
+ getFrom
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetPort"
id="getPort"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">getPort</span> (line
<span class="line-number">100</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+
+ <div class="method-signature">
+ <span
class="method-result">integer</span>
+ <span class="method-name">
+ getPort
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetSmtpHost"
id="getSmtpHost"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">getSmtpHost</span>
(line <span
class="line-number">105</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+
+ <div class="method-signature">
+ <span
class="method-result">string</span>
+ <span class="method-name">
+ getSmtpHost
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetSubject"
id="getSubject"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">getSubject</span>
(line <span
class="line-number">110</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+
+ <div class="method-signature">
+ <span
class="method-result">string</span>
+ <span class="method-name">
+ getSubject
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetTo"
id="getTo"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">getTo</span> (line
<span class="line-number">115</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+
+ <div class="method-signature">
+ <span
class="method-result">string</span>
+ <span class="method-name">
+ getTo
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodsetFrom"
id="setFrom"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">setFrom</span> (line
<span class="line-number">117</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+
+ <div class="method-signature">
+ <span
class="method-result">void</span>
+ <span class="method-name">
+ setFrom
+ </span>
+ (<span
class="var-type"></span> <spa
n class="var-name">$from</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type"></span>
+ <span
class="var-name">$from</span> </li&g
t;
+ </ul>
+
+
+ </div>
+<a name="methodsetPort"
id="setPort"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">setPort</span> (line
<span class="line-number">118</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+
+ <div class="method-signature">
+ <span
class="method-result">void</span>
+ <span class="method-name">
+ setPort
+ </span>
+ (<span
class="var-type"></span> <spa
n class="var-name">$port</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type"></span>
+ <span
class="var-name">$port</span> </li&g
t;
+ </ul>
+
+
+ </div>
+<a name="methodsetSmtpHost"
id="setSmtpHost"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">setSmtpHost</span>
(line <span
class="line-number">119</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+
+ <div class="method-signature">
+ <span
class="method-result">void</span>
+ <span class="method-name">
+ setSmtpHost
+ </span>
+ (<span
class="var-type"></span> <spa
n class="var-name">$smtpHost</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type"></span>
+ <span
class="var-name">$smtpHost</span> </
li>
+ </ul>
+
+
+ </div>
+<a name="methodsetSubject"
id="setSubject"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">setSubject</span>
(line <span
class="line-number">120</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+
+ <div class="method-signature">
+ <span
class="method-result">void</span>
+ <span class="method-name">
+ setSubject
+ </span>
+ (<span
class="var-type"></span> <spa
n class="var-name">$subject</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type"></span>
+ <span
class="var-name">$subject</span> </l
i>
+ </ul>
+
+
+ </div>
+<a name="methodsetTo"
id="setTo"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">setTo</span> (line
<span class="line-number">121</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+
+ <div class="method-signature">
+ <span
class="method-result">void</span>
+ <span class="method-name">
+ setTo
+ </span>
+ (<span
class="var-type"></span> <spa
n class="var-name">$to</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type"></span>
+ <span
class="var-name">$to</span> </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
Added:
incubator/log4php/site/apidocs/log4php/appenders/LoggerAppen
derNull.html
URL: http://svn.apache.org/viewvc/incubator/log4php
/site/apidocs/log4php/appenders/LoggerAppenderNull.html?view
=auto&rev=558223
============================================================
==================
---
incubator/log4php/site/apidocs/log4php/appenders/LoggerAppen
derNull.html (added)
+++
incubator/log4php/site/apidocs/log4php/appenders/LoggerAppen
derNull.html Fri Jul 20 19:10:17 2007
 -0,0
+1,327 
+<?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
LoggerAppenderNull</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
LoggerAppenderNull</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">A NullAppender
merely exists, it never outputs a message to any
device.</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---LoggerAppenderNull.php.html">
;/appenders/LoggerAppenderNull.php</a> (line <span
class="field">27</span>)
+ </p>
+
+
+ <pre><a
href="../../log4php/LoggerAppender.html">Logger
Appender</a>
+ |
+ --<a
href="../../log4php/LoggerAppenderSkeleton.html"&g
t;LoggerAppenderSkeleton</a>
+ |
+ --LoggerAppenderNull</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">mixed</span>
+ <a href="#$requiresLayout"
title="details"
class="var-name">$requiresLayout</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">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"><a
href="../../log4php/spi/LoggerLoggingEvent.html"&g
t;LoggerLoggingEvent</a></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">
+ <a name="var$requiresLayout"
id="$requiresLayout"><!-- --></A>
+<div class="oddrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span
class="var-type">mixed</span>
+ <span
class="var-name">$requiresLayout</span>
+ = <span class="var-default">
false</span> (line <span
class="line-number">32</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">access:</span>
protected</li>
+ </ul>
+
+
+ <hr class="separator" />
+ <div class="notes">Redefinition
of:</div>
+ <dl>
+ <dt><a
href="../../log4php/LoggerAppenderSkeleton.html#var$req
uiresLayout">LoggerAppenderSkeleton::$requiresLayout
</a></dt>
+ </dl>
+
+
+
+</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="methodactivateOptions"
id="activateOptions"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">activateOptions</span&g
t; (line <span
class="line-number">34</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="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">append</span> (line
<span class="line-number">50</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Do
nothing.</p>
+<p class="description"><p>How I Love
it !! </p>&
lt;/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">
+ append
+ </span>
+ (<span class="var-type"><a
href="../../log4php/spi/LoggerLoggingEvent.html"&g
t;LoggerLoggingEvent</a></span> <spa
n class="var-name">$event</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type"><a
href="../../log4php/spi/LoggerLoggingEvent.html"&g
t;LoggerLoggingEvent</a></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">39</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>
+ <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
derPhp.html
URL: http://svn.apache.org/viewvc/incubator/log4php/
site/apidocs/log4php/appenders/LoggerAppenderPhp.html?view=a
uto&rev=558223
============================================================
==================
---
incubator/log4php/site/apidocs/log4php/appenders/LoggerAppen
derPhp.html (added)
+++
incubator/log4php/site/apidocs/log4php/appenders/LoggerAppen
derPhp.html Fri Jul 20 19:10:17 2007
 -0,0
+1,284 
+<?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
LoggerAppenderPhp</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
LoggerAppenderPhp</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">Log events
using php <a href="http://www.php.net/trigger_e
rror">http://www.php.net/trigger_error</a>
function and a <a
href="../../log4php/layouts/LoggerLayoutTTCC.html"
>LoggerLayoutTTCC</a> default layout.</p>
+<p class="description"><p>Levels are
mapped as
follows:</p><p><ul><li><strong>
;level &lt; WARN</strong> mapped to
E_USER_NOTICE</li><li><strong>WARN
&lt;= level &lt; ERROR</strong> mapped
to E_USER_WARNING</li><li><strong>level
&gt;= ERROR</strong> mapped to
E_USER_ERROR</li></ul></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---LoggerAppenderPhp.php.html">
/appenders/LoggerAppenderPhp.php</a> (line <span
class="field">35</span>)
+ </p>
+
+
+ <pre><a
href="../../log4php/LoggerAppender.html">Logger
Appender</a>
+ |
+ --<a
href="../../log4php/LoggerAppenderSkeleton.html"&g
t;LoggerAppenderSkeleton</a>
+ |
+ --LoggerAppenderPhp</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$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-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">38</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">47</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>
+
+ </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">43</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>
+ <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
|