Added:
incubator/log4php/site/apidocs/log4php/helpers/_helpers---Lo
ggerTransform.php.html
URL: http://svn.apache.org/viewvc/incubat
or/log4php/site/apidocs/log4php/helpers/_helpers---LoggerTra
nsform.php.html?view=auto&rev=558223
============================================================
==================
---
incubator/log4php/site/apidocs/log4php/helpers/_helpers---Lo
ggerTransform.php.html (added)
+++
incubator/log4php/site/apidocs/log4php/helpers/_helpers---Lo
ggerTransform.php.html Fri Jul 20 19:10:17 2007
 -0,0
+1,131
+<?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 page
LoggerTransform.php</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="file-name">/helpers/LoggerTransform.php&
lt;/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-classes">Classes</a>
+ | <a
href="#sec-constants">Constants</a>
+ </div>
+ <div class="info-box-body">
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Copyright 2004
The Apache Software Foundation.</p>
+<p class="description"><p>This
software is published under the terms of the Apache Software
License version 2.0, a copy of which has been included with
this distribution in the LICENSE file.</p></p>
+
+ </div>
+</div>
+
+ <a name="sec-classes"></a>
+ <div class="info-box">
+ <div
class="info-box-title">Classes</div>
+ <div class="nav-bar">
+ <a
href="#sec-description">Description</a>
|
+ <span
class="disabled">Classes</span>
+ | <a
href="#sec-constants">Constants</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; vertical-align:
top">
+ <a
href="../../log4php/helpers/LoggerTransform.html"&
gt;LoggerTransform</a>
+ </td>
+ <td>
+ Utility class for transforming strings.
+ </td>
+ </tr>
+ </table>
+ </div>
+ </div>
+
+
+ <a name="sec-constants"></a>
+ <div class="info-box">
+ <div
class="info-box-title">Constants</div>
+ <div class="nav-bar">
+ <a
href="#sec-description">Description</a>
|
+ <a
href="#sec-classes">Classes</a>
+ | <span
class="disabled">Constants</span>
+ </div>
+ <div class="info-box-body">
+ <a
name="defineLOG4PHP_LOGGER_TRANSFORM_CDATA_EMBEDDED_END
"><!-- --></a>
+<div class="oddrow">
+
+ <div>
+ <span class="const-title">
+ <span
class="const-name">LOG4PHP_LOGGER_TRANSFORM_CDA
TA_EMBEDDED_END</span> =
LOG4PHP_LOGGER_TRANSFORM_CDATA_END.LOG4PHP_LOGGER_TRANSFORM_
CDATA_PSEUDO_END.LOG4PHP_LOGGER_TRANSFORM_CDATA_START
+ (line <span
class="line-number">21</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+
+
+</div>
+<a
name="defineLOG4PHP_LOGGER_TRANSFORM_CDATA_END">
;<!-- --></a>
+<div class="evenrow">
+
+ <div>
+ <span class="const-title">
+ <span
class="const-name">LOG4PHP_LOGGER_TRANSFORM_CDA
TA_END</span> = ']]>'
+ (line <span
class="line-number">19</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+
+
+</div>
+<a
name="defineLOG4PHP_LOGGER_TRANSFORM_CDATA_PSEUDO_END&q
uot;><!-- --></a>
+<div class="oddrow">
+
+ <div>
+ <span class="const-title">
+ <span
class="const-name">LOG4PHP_LOGGER_TRANSFORM_CDA
TA_PSEUDO_END</span> = ']]&gt;'
+ (line <span
class="line-number">20</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+
+
+</div>
+<a
name="defineLOG4PHP_LOGGER_TRANSFORM_CDATA_START"&
gt;<!-- --></a>
+<div class="evenrow">
+
+ <div>
+ <span class="const-title">
+ <span
class="const-name">LOG4PHP_LOGGER_TRANSFORM_CDA
TA_START</span> = '<![CDATA['
+ (line <span
class="line-number">18</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+
+
+</div>
+ </div>
+ </div>
+
+
+
+ <p class="notes" id="credit">
+ Documentation generated on Fri, 20 Jul 2007 22:08:22
-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/layouts/LoggerLayoutH
tml.html
URL: http://svn.apache.org/viewvc/incubator/log4php/sit
e/apidocs/log4php/layouts/LoggerLayoutHtml.html?view=auto&am
p;rev=558223
============================================================
==================
---
incubator/log4php/site/apidocs/log4php/layouts/LoggerLayoutH
tml.html (added)
+++
incubator/log4php/site/apidocs/log4php/layouts/LoggerLayoutH
tml.html Fri Jul 20 19:10:17 2007
-0,0
+1,490
+<?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
LoggerLayoutHtml</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
LoggerLayoutHtml</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">This layout
outputs events in a HTML table.</p>
+<p class="description"><p>Parameters
are: <a
href="../../log4php/layouts/LoggerLayoutHtml.html#var$t
itle">$title</a>, <a
href="../../log4php/layouts/LoggerLayoutHtml.html#var$l
ocationInfo">$locationInfo</a>.</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="_layouts---LoggerLayoutHtml.php.html">/la
youts/LoggerLayoutHtml.php</a> (line <span
class="field">47</span>)
+ </p>
+
+
+ <pre><a
href="../../log4php/LoggerLayout.html">LoggerLa
yout</a>
+ |
+ --LoggerLayoutHtml</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="#$locationInfo"
title="details"
class="var-name">$locationInfo</a>
+ </div>
+ <div class="var-title">
+ <span
class="var-type">string</span>
+ <a href="#$title"
title="details"
class="var-name">$title</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">LoggerLayoutHtml</span
>
+ <a href="#LoggerLayoutHtml"
title="details"
class="method-name">LoggerLayoutHtml</a>
+ ()
+ </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">string</span>
+ <a href="#format"
title="details"
class="method-name">format</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">string</span>
+ <a href="#getContentType"
title="details"
class="method-name">getContentType</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">string</span>
+ <a href="#getFooter"
title="details"
class="method-name">getFooter</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">string</span>
+ <a href="#getHeader"
title="details"
class="method-name">getHeader</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#getLocationInfo"
title="details"
class="method-name">getLocationInfo</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">string</span>
+ <a href="#getTitle"
title="details"
class="method-name">getTitle</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#setLocationInfo"
title="details"
class="method-name">setLocationInfo</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="#setTitle"
title="details"
class="method-name">setTitle</a>
+ (<span
class="var-type"></span> <spa
n class="var-name">$title</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$locationInfo"
id="$locationInfo"><!-- --></A>
+<div class="evenrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span
class="var-type">boolean</span>
+ <span
class="var-name">$locationInfo</span>
+ = <span class="var-default">
false</span> (line <span
class="line-number">61</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">The
<strong>LocationInfo</strong> option takes a
boolean value. By</p>
+<p class="description"><p>default, it
is set to false which means there will be no location
information output by this layout. If the the option is set
to true, then the file name and line number of the
statement at the origin of the log statement will be
output.</p><p><p>If you are
embedding this layout within a <a
href="../../log4php/appenders/LoggerAppenderMail.html&q
uot;>LoggerAppenderMail</a> or a <a
href="../../log4php/appenders/LoggerAppenderMailEvent.h
tml">LoggerAppenderMailEvent</a> then make
sure to set the <strong>LocationInfo</strong>
option of that appender as well.</p></p>
+
+
+
+
+
+</div>
+<a name="var$title"
id="$title"><!-- --></A>
+<div class="oddrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span
class="var-type">string</span>
+ <span
class="var-name">$title</span>
+ = <span class="var-default">
"Log4php Log
Messages"</span> (line <span
class="line-number">69</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">The
<strong>Title</strong> option takes a String
value. This option sets the document title of the generated
HTML document.</p>
+<p class="description"><p>Defaults to
'Log4php Log Messages'.</p></p>
+
+
+
+
+
+</div>
+
+ </div>
+ </div>
+
+ <a name="sec-methods"></a>
+ <div class="info-box">
+ <div
class="info-box-title">Methods</div>
+ <div class="nav-bar">
+ <a
href="#sec-description">Description</a>
|
+ <a
href="#sec-var-summary">Vars</a> (<a
href="#sec-vars">details</a>)
+ <a
href="#sec-method-summary">Methods</a>
(<span
class="disabled">details</span>)
+
+ </div>
+ <div class="info-box-body">
+ <A NAME='method_detail'></A>
+
+<a name="methodLoggerLayoutHtml"
id="LoggerLayoutHtml"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">Constructor
LoggerLayoutHtml</span> (line <span
class="line-number">74</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p
class="short-description">Constructor</p>
+
+ <div class="method-signature">
+ <span
class="method-result">LoggerLayoutHtml</span
>
+ <span class="method-name">
+ LoggerLayoutHtml
+ </span>
+ ()
+ </div>
+
+
+
+ </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">136</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">No options to
activate.</p>
+
+ <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/LoggerLayout.html#methodactivateOpt
ions">LoggerLayout::activateOptions()</a></
dt>
+ <dd>Override this method</dd>
+ </dl>
+
+ </div>
+<a name="methodformat"
id="format"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">format</span> (line
<span class="line-number">145</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+
+ <div class="method-signature">
+ <span
class="method-result">string</span>
+ <span class="method-name">
+ format
+ </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/LoggerLayout.html#methodformat"
;>LoggerLayout::format()</a></dt>
+ <dd>Override this method to create your own
layout format.</dd>
+ </dl>
+
+ </div>
+<a name="methodgetContentType"
id="getContentType"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">getContentType</span>
; (line <span
class="line-number">128</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">return:</span> Returns the
content type output by this layout, i.e
"text/html".</li>
+ </ul>
+
+ <div class="method-signature">
+ <span
class="method-result">string</span>
+ <span class="method-name">
+ getContentType
+ </span>
+ ()
+ </div>
+
+
+ <hr class="separator" />
+ <div class="notes">Redefinition
of:</div>
+ <dl>
+ <dt><a
href="../../log4php/LoggerLayout.html#methodgetContentT
ype">LoggerLayout::getContentType()</a></dt
>
+ <dd>Returns the content type output by this
layout.</dd>
+ </dl>
+
+ </div>
+<a name="methodgetFooter"
id="getFooter"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">getFooter</span>
(line <span
class="line-number">240</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">return:</span> Returns the
appropriate HTML footers.</li>
+ </ul>
+
+ <div class="method-signature">
+ <span
class="method-result">string</span>
+ <span class="method-name">
+ getFooter
+ </span>
+ ()
+ </div>
+
+
+ <hr class="separator" />
+ <div class="notes">Redefinition
of:</div>
+ <dl>
+ <dt><a
href="../../log4php/LoggerLayout.html#methodgetFooter&q
uot;>LoggerLayout::getFooter()</a></dt>
+ <dd>Returns the footer for the layout
format.</dd>
+ </dl>
+
+ </div>
+<a name="methodgetHeader"
id="getHeader"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">getHeader</span>
(line <span
class="line-number">206</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">return:</span> Returns
appropriate HTML headers.</li>
+ </ul>
+
+ <div class="method-signature">
+ <span
class="method-result">string</span>
+ <span class="method-name">
+ getHeader
+ </span>
+ ()
+ </div>
+
+
+ <hr class="separator" />
+ <div class="notes">Redefinition
of:</div>
+ <dl>
+ <dt><a
href="../../log4php/LoggerLayout.html#methodgetHeader&q
uot;>LoggerLayout::getHeader()</a></dt>
+ <dd>Returns the header for the layout
format.</dd>
+ </dl>
+
+ </div>
+<a name="methodgetLocationInfo"
id="getLocationInfo"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">getLocationInfo</span&g
t; (line <span
class="line-number">102</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Returns the
current value of the
<strong>LocationInfo</strong> option.</p>
+
+ <div class="method-signature">
+ <span
class="method-result">void</span>
+ <span class="method-name">
+ getLocationInfo
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetTitle"
id="getTitle"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">getTitle</span>
(line <span
class="line-number">120</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">return:</span> Returns the
current value of the <strong>Title</strong>
option.</li>
+ </ul>
+
+ <div class="method-signature">
+ <span
class="method-result">string</span>
+ <span class="method-name">
+ getTitle
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodsetLocationInfo"
id="setLocationInfo"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">setLocationInfo</span&g
t; (line <span
class="line-number">90</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">The
<strong>LocationInfo</strong> option takes a
boolean value. By</p>
+<p class="description"><p>default, it
is set to false which means there will be no location
information output by this layout. If the the option is set
to true, then the file name and line number of the
statement at the origin of the log statement will be
output.</p><p><p>If you are
embedding this layout within a <a
href="../../log4php/appenders/LoggerAppenderMail.html&q
uot;>LoggerAppenderMail</a> or a <a
href="../../log4php/appenders/LoggerAppenderMailEvent.h
tml">LoggerAppenderMailEvent</a> then make
sure to set the <strong>LocationInfo</strong>
option of that appender as well.</p></p>
+
+ <div class="method-signature">
+ <span
class="method-result">void</span>
+ <span class="method-name">
+ setLocationInfo
+ </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="methodsetTitle"
id="setTitle"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">setTitle</span>
(line <span
class="line-number">112</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">The
<strong>Title</strong> option takes a String
value. This option sets the document title of the generated
HTML document.</p>
+<p class="description"><p>Defaults to
'Log4php Log Messages'.</p></p>
+
+ <div class="method-signature">
+ <span
class="method-result">void</span>
+ <span class="method-name">
+ setTitle
+ </span>
+ (<span
class="var-type"></span> <spa
n class="var-name">$title</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type"></span>
+ <span
class="var-name">$title</span> </li&
gt;
+ </ul>
+
+
+ </div>
+ <h4>Inherited Methods</h4>
+ <a name='inherited_methods'><!--
--></a>
+ <!-- =========== Summary =========== -->
+ <p>Inherited From <span
class="classname"><a
href="../../log4php/LoggerLayout.html">LoggerLa
yout</a></span></p>
+ <blockquote>
+ <span
class="method-name"><a
href="../../log4php/LoggerLayout.html#methodactivateOpt
ions">LoggerLayout::activateOptions()</a></
span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerLayout.html#methodfactory&quo
t;>LoggerLayout::factory()</a></span><br&g
t;
+ <span
class="method-name"><a
href="../../log4php/LoggerLayout.html#methodformat"
;>LoggerLayout::format()</a></span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerLayout.html#methodgetContentT
ype">LoggerLayout::getContentType()</a></sp
an><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerLayout.html#methodgetFooter&q
uot;>LoggerLayout::getFooter()</a></span><
br>
+ <span
class="method-name"><a
href="../../log4php/LoggerLayout.html#methodgetHeader&q
uot;>LoggerLayout::getHeader()</a></span><
br>
+ </blockquote>
+
+ </div>
+ </div>
+
+
+ <p class="notes" id="credit">
+ Documentation generated on Fri, 20 Jul 2007 22:08:18
-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/layouts/LoggerLayoutS
imple.html
URL: http://svn.apache.org/viewvc/incubator/log4php/s
ite/apidocs/log4php/layouts/LoggerLayoutSimple.html?view=aut
o&rev=558223
============================================================
==================
---
incubator/log4php/site/apidocs/log4php/layouts/LoggerLayoutS
imple.html (added)
+++
incubator/log4php/site/apidocs/log4php/layouts/LoggerLayoutS
imple.html Fri Jul 20 19:10:17 2007
-0,0
+1,187
+<?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
LoggerLayoutSimple</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
LoggerLayoutSimple</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-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 simple
layout.</p>
+<p class="description"><p>Returns the
log statement in a format consisting of the
<strong>level</strong>, followed by " -
" and then the
<strong>message</strong>. For example,
<samp>INFO - "A
message"</samp></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="_layouts---LoggerLayoutSimple.php.html">/
layouts/LoggerLayoutSimple.php</a> (line <span
class="field">47</span>)
+ </p>
+
+
+ <pre><a
href="../../log4php/LoggerLayout.html">LoggerLa
yout</a>
+ |
+ --LoggerLayoutSimple</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>
|
+ <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">LoggerLayoutSimple</sp
an>
+ <a href="#LoggerLayoutSimple"
title="details"
class="method-name">LoggerLayoutSimple</a>
;
+ ()
+ </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">string</span>
+ <a href="#format"
title="details"
class="method-name">format</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>
+ </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-method-summary">Methods</a>
(<span
class="disabled">details</span>)
+
+ </div>
+ <div class="info-box-body">
+ <A NAME='method_detail'></A>
+
+<a name="methodLoggerLayoutSimple"
id="LoggerLayoutSimple"><!--
--></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">Constructor
LoggerLayoutSimple</span> (line <span
class="line-number">52</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p
class="short-description">Constructor</p>
+
+ <div class="method-signature">
+ <span
class="method-result">LoggerLayoutSimple</sp
an>
+ <span class="method-name">
+ LoggerLayoutSimple
+ </span>
+ ()
+ </div>
+
+
+
+ </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">57</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/LoggerLayout.html#methodactivateOpt
ions">LoggerLayout::activateOptions()</a></
dt>
+ <dd>Override this method</dd>
+ </dl>
+
+ </div>
+<a name="methodformat"
id="format"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">format</span> (line
<span class="line-number">71</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Returns the
log statement in a format consisting of the</p>
+<p
class="description"><p><strong>leve
l</strong>, followed by " - " and
then the <strong>message</strong>. For example,
<samp>INFO - "A
message"</samp></p></p>
+
+ <div class="method-signature">
+ <span
class="method-result">string</span>
+ <span class="method-name">
+ format
+ </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/LoggerLayout.html#methodformat"
;>LoggerLayout::format()</a></dt>
+ <dd>Override this method to create your own
layout format.</dd>
+ </dl>
+
+ </div>
+ <h4>Inherited Methods</h4>
+ <a name='inherited_methods'><!--
--></a>
+ <!-- =========== Summary =========== -->
+ <p>Inherited From <span
class="classname"><a
href="../../log4php/LoggerLayout.html">LoggerLa
yout</a></span></p>
+ <blockquote>
+ <span
class="method-name"><a
href="../../log4php/LoggerLayout.html#methodactivateOpt
ions">LoggerLayout::activateOptions()</a></
span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerLayout.html#methodfactory&quo
t;>LoggerLayout::factory()</a></span><br&g
t;
+ <span
class="method-name"><a
href="../../log4php/LoggerLayout.html#methodformat"
;>LoggerLayout::format()</a></span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerLayout.html#methodgetContentT
ype">LoggerLayout::getContentType()</a></sp
an><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerLayout.html#methodgetFooter&q
uot;>LoggerLayout::getFooter()</a></span><
br>
+ <span
class="method-name"><a
href="../../log4php/LoggerLayout.html#methodgetHeader&q
uot;>LoggerLayout::getHeader()</a></span><
br>
+ </blockquote>
+
+ </div>
+ </div>
+
+
+ <p class="notes" id="credit">
+ Documentation generated on Fri, 20 Jul 2007 22:08:18
-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/layouts/LoggerLayoutT
TCC.html
URL: http://svn.apache.org/viewvc/incubator/log4php/sit
e/apidocs/log4php/layouts/LoggerLayoutTTCC.html?view=auto&am
p;rev=558223
============================================================
==================
---
incubator/log4php/site/apidocs/log4php/layouts/LoggerLayoutT
TCC.html (added)
+++
incubator/log4php/site/apidocs/log4php/layouts/LoggerLayoutT
TCC.html Fri Jul 20 19:10:17 2007
-0,0
+1,707
+<?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
LoggerLayoutTTCC</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
LoggerLayoutTTCC</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">TTCC layout
format consists of time, thread, category and nested
diagnostic context information, hence the name.</p>
+<p class="description"><p>Each of the
four fields can be individually enabled or disabled. The
time format depends on the
<strong>DateFormat</strong>
used.</p><p>If no dateFormat is specified it
defaults to '%c'. See php <a href="http://www.php.net/date">http://www.ph
p.net/date</a> function for
details.</p><p>Params:<ul><li><a
href="../../log4php/layouts/LoggerLayoutTTCC.html#var$t
hreadPrinting">$threadPrinting</a>
(true|false) enable/disable pid
reporting.</li><li><a
href="../../log4php/layouts/LoggerLayoutTTCC.html#var$c
ategoryPrefixing">$categoryPrefixing</a>
(true|false) enable/disable logger category
reporting.</li><li><a
href="../../log4php/layouts/LoggerLayoutTTCC.html#var$c
ontextPrinting">$contextPrinting</a>
(true|false) enable/disable NDC
reporting.</li><li><a
href="../../log4php/layouts/LoggerLayoutTTCC.html#var$m
icroSecondsPrinting">$microSecondsPrinting</a>
(true|false) enable/disable micro seconds reporting in
timestamp.</li><li><a
href="../../log4php/layouts
/LoggerLayoutTTCC.html#var$dateFormat">$dateFormat&
lt;/a> (string) set date format. See php <a
href="http://www.php.net/date">http://www.ph
p.net/date</a> function for
details.</li></ul></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="_layouts---LoggerLayoutTTCC.php.html">/la
youts/LoggerLayoutTTCC.php</a> (line <span
class="field">70</span>)
+ </p>
+
+
+ <pre><a
href="../../log4php/LoggerLayout.html">LoggerLa
yout</a>
+ |
+ --LoggerLayoutTTCC</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="#$categoryPrefixing"
title="details"
class="var-name">$categoryPrefixing</a>
+ </div>
+ <div class="var-title">
+ <span
class="var-type">mixed</span>
+ <a href="#$contextPrinting"
title="details"
class="var-name">$contextPrinting</a>
+ </div>
+ <div class="var-title">
+ <span
class="var-type">string</span>
+ <a href="#$dateFormat"
title="details"
class="var-name">$dateFormat</a>
+ </div>
+ <div class="var-title">
+ <span
class="var-type">mixed</span>
+ <a href="#$microSecondsPrinting"
title="details"
class="var-name">$microSecondsPrinting</a>
;
+ </div>
+ <div class="var-title">
+ <span
class="var-type">mixed</span>
+ <a href="#$threadPrinting"
title="details"
class="var-name">$threadPrinting</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">LoggerLayoutTTCC</span
>
+ <a href="#__construct"
title="details"
class="method-name">__construct</a>
+ ([<span
class="var-type">string</span> &
lt;span
class="var-name">$dateFormat</span> =
<span class="var-default">''</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">string</span>
+ <a href="#format"
title="details"
class="method-name">format</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">boolean</span>
+ <a href="#getCategoryPrefixing"
title="details"
class="method-name">getCategoryPrefixing</a&
gt;
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">boolean</span>
+ <a href="#getContextPrinting"
title="details"
class="method-name">getContextPrinting</a>
;
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">string</span>
+ <a href="#getDateFormat"
title="details"
class="method-name">getDateFormat</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">boolean</span>
+ <a href="#getMicroSecondsPrinting"
title="details"
class="method-name">getMicroSecondsPrinting<
/a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">boolean</span>
+ <a href="#getThreadPrinting"
title="details"
class="method-name">getThreadPrinting</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#ignoresThrowable"
title="details"
class="method-name">ignoresThrowable</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#setCategoryPrefixing"
title="details"
class="method-name">setCategoryPrefixing</a&
gt;
+ (<span
class="var-type"></span> <spa
n
class="var-name">$categoryPrefixing</span>
;)
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#setContextPrinting"
title="details"
class="method-name">setContextPrinting</a>
;
+ (<span
class="var-type"></span> <spa
n
class="var-name">$contextPrinting</span>)
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#setDateFormat"
title="details"
class="method-name">setDateFormat</a>
+ (<span
class="var-type"></span> <spa
n class="var-name">$dateFormat</span>)
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#setMicroSecondsPrinting"
title="details"
class="method-name">setMicroSecondsPrinting<
/a>
+ (<span
class="var-type"></span> <spa
n
class="var-name">$microSecondsPrinting</span
>)
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#setThreadPrinting"
title="details"
class="method-name">setThreadPrinting</a>
+ (<span
class="var-type"></span> <spa
n
class="var-name">$threadPrinting</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$categoryPrefixing"
id="$categoryPrefixing"><!--
--></A>
+<div class="oddrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span
class="var-type">mixed</span>
+ <span
class="var-name">$categoryPrefixing</span>
;
+ = <span class="var-default">
true</span> (line <span
class="line-number">74</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">access:</span>
protected</li>
+ </ul>
+
+
+
+
+
+</div>
+<a name="var$contextPrinting"
id="$contextPrinting"><!-- --></A>
+<div class="evenrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span
class="var-type">mixed</span>
+ <span
class="var-name">$contextPrinting</span>
+ = <span class="var-default">
true</span> (line <span
class="line-number">75</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">access:</span>
protected</li>
+ </ul>
+
+
+
+
+
+</div>
+<a name="var$dateFormat"
id="$dateFormat"><!-- --></A>
+<div class="oddrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span
class="var-type">string</span>
+ <span
class="var-name">$dateFormat</span>
+ = <span class="var-default">
'%c'</span> (line <span
class="line-number">81</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">var:</span> date format.
See <a href="http://www.php.net/strftime">h
ttp://www.php.net/strftime</a> for
details</li>
+ <li><span
class="field">access:</span>
protected</li>
+ </ul>
+
+
+
+
+
+</div>
+<a name="var$microSecondsPrinting"
id="$microSecondsPrinting"><!--
--></A>
+<div class="evenrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span
class="var-type">mixed</span>
+ <span
class="var-name">$microSecondsPrinting</span
>
+ = <span class="var-default">
true</span> (line <span
class="line-number">76</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">access:</span>
protected</li>
+ </ul>
+
+
+
+
+
+</div>
+<a name="var$threadPrinting"
id="$threadPrinting"><!-- --></A>
+<div class="oddrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span
class="var-type">mixed</span>
+ <span
class="var-name">$threadPrinting</span>
+ = <span class="var-default">
true</span> (line <span
class="line-number">73</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">access:</span>
protected</li>
+ </ul>
+
+
+
+
+
+</div>
+
+ </div>
+ </div>
+
+ <a name="sec-methods"></a>
+ <div class="info-box">
+ <div
class="info-box-title">Methods</div>
+ <div class="nav-bar">
+ <a
href="#sec-description">Description</a>
|
+ <a
href="#sec-var-summary">Vars</a> (<a
href="#sec-vars">details</a>)
+ <a
href="#sec-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">89</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p
class="short-description">Constructor</p>
+ <ul class="tags">
+ <li><span
class="field">see:</span> <a
href="../../log4php/layouts/LoggerLayoutTTCC.html#var$d
ateFormat">LoggerLayoutTTCC::$dateFormat</a>&l
t;/li>
+ <li><span
class="field">access:</span>
public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span
class="method-result">LoggerLayoutTTCC</span
>
+ <span class="method-name">
+ __construct
+ </span>
+ ([<span
class="var-type">string</span> &
lt;span
class="var-name">$dateFormat</span> =
<span class="var-default">''</span>])
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span
class="var-type">string</span>
+ <span
class="var-name">$dateFormat</span><sp
an class="var-description">: date
format</span> </li>
+ </ul>
+
+
+ </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">96</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/LoggerLayout.html#methodactivateOpt
ions">LoggerLayout::activateOptions()</a></
dt>
+ <dd>Override this method</dd>
+ </dl>
+
+ </div>
+<a name="methodformat"
id="format"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">format</span> (line
<span class="line-number">197</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">In addition to
the level of the statement and message, the returned string
includes time, thread, category.</p>
+<p class="description"><p>Time,
thread, category are printed depending on
options.</p></p>
+ <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">
+ format
+ </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/LoggerLayout.html#methodformat"
;>LoggerLayout::format()</a></dt>
+ <dd>Override this method to create your own
layout format.</dd>
+ </dl>
+
+ </div>
+<a name="methodgetCategoryPrefixing"
id="getCategoryPrefixing"><!--
--></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">getCategoryPrefixing</s
pan> (line <span
class="line-number">133</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">return:</span> Returns
value of the <strong>CategoryPrefixing</strong>
option.</li>
+ <li><span
class="field">access:</span>
public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span
class="method-result">boolean</span>
+ <span class="method-name">
+ getCategoryPrefixing
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetContextPrinting"
id="getContextPrinting"><!--
--></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">getContextPrinting</spa
n> (line <span
class="line-number">151</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">return:</span> Returns
value of the <strong>ContextPrinting</strong>
option.</li>
+ <li><span
class="field">access:</span>
public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span
class="method-result">boolean</span>
+ <span class="method-name">
+ getContextPrinting
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetDateFormat"
id="getDateFormat"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">getDateFormat</span>
(line <span
class="line-number">184</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">
+ getDateFormat
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetMicroSecondsPrinting"
id="getMicroSecondsPrinting"><!--
--></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">getMicroSecondsPrinting<
;/span> (line <span
class="line-number">170</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">return:</span> Returns
value of the
<strong>MicroSecondsPrinting</strong>
option.</li>
+ <li><span
class="field">access:</span>
public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span
class="method-result">boolean</span>
+ <span class="method-name">
+ getMicroSecondsPrinting
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodgetThreadPrinting"
id="getThreadPrinting"><!--
--></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">getThreadPrinting</span
> (line <span
class="line-number">115</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">return:</span> Returns
value of the <strong>ThreadPrinting</strong>
option.</li>
+ <li><span
class="field">access:</span>
public</li>
+ </ul>
+
+ <div class="method-signature">
+ <span
class="method-result">boolean</span>
+ <span class="method-name">
+ getThreadPrinting
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodignoresThrowable"
id="ignoresThrowable"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">ignoresThrowable</span&
gt; (line <span
class="line-number">232</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">
+ ignoresThrowable
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodsetCategoryPrefixing"
id="setCategoryPrefixing"><!--
--></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">setCategoryPrefixing</s
pan> (line <span
class="line-number">123</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">The
<strong>CategoryPrefixing</strong> option
specifies whether Category name is part of log output or
not. This is true by default.</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">
+ setCategoryPrefixing
+ </span>
+ (<span
class="var-type"></span> <spa
n
class="var-name">$categoryPrefixing</span>
;)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type"></span>
+ <span
class="var-name">$categoryPrefixing</span>
; </li>
+ </ul>
+
+
+ </div>
+<a name="methodsetContextPrinting"
id="setContextPrinting"><!--
--></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">setContextPrinting</spa
n> (line <span
class="line-number">142</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">The
<strong>ContextPrinting</strong> option
specifies log output will include the nested context
information belonging to the current thread.</p>
+<p class="description"><p>This is
true by default.</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">
+ setContextPrinting
+ </span>
+ (<span
class="var-type"></span> <spa
n
class="var-name">$contextPrinting</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type"></span>
+ <span
class="var-name">$contextPrinting</span>
</li>
+ </ul>
+
+
+ </div>
+<a name="methodsetDateFormat"
id="setDateFormat"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">setDateFormat</span>
(line <span
class="line-number">176</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">
+ setDateFormat
+ </span>
+ (<span
class="var-type"></span> <spa
n class="var-name">$dateFormat</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type"></span>
+ <span
class="var-name">$dateFormat</span> <
;/li>
+ </ul>
+
+
+ </div>
+<a name="methodsetMicroSecondsPrinting"
id="setMicroSecondsPrinting"><!--
--></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">setMicroSecondsPrinting<
;/span> (line <span
class="line-number">161</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">The
<strong>MicroSecondsPrinting</strong> option
specifies if microseconds infos should be printed at the
end of timestamp.</p>
+<p class="description"><p>This is
true by default.</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">
+ setMicroSecondsPrinting
+ </span>
+ (<span
class="var-type"></span> <spa
n
class="var-name">$microSecondsPrinting</span
>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type"></span>
+ <span
class="var-name">$microSecondsPrinting</span
> </li>
+ </ul>
+
+
+ </div>
+<a name="methodsetThreadPrinting"
id="setThreadPrinting"><!--
--></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">setThreadPrinting</span
> (line <span
class="line-number">104</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">The
<strong>ThreadPrinting</strong> option specifies
whether the name of the current thread is part of log
output or not. This is true by default.</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">
+ setThreadPrinting
+ </span>
+ (<span
class="var-type"></span> <spa
n
class="var-name">$threadPrinting</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type"></span>
+ <span
class="var-name">$threadPrinting</span>
</li>
+ </ul>
+
+
+ </div>
+ <h4>Inherited Methods</h4>
+ <a name='inherited_methods'><!--
--></a>
+ <!-- =========== Summary =========== -->
+ <p>Inherited From <span
class="classname"><a
href="../../log4php/LoggerLayout.html">LoggerLa
yout</a></span></p>
+ <blockquote>
+ <span
class="method-name"><a
href="../../log4php/LoggerLayout.html#methodactivateOpt
ions">LoggerLayout::activateOptions()</a></
span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerLayout.html#methodfactory&quo
t;>LoggerLayout::factory()</a></span><br&g
t;
+ <span
class="method-name"><a
href="../../log4php/LoggerLayout.html#methodformat"
;>LoggerLayout::format()</a></span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerLayout.html#methodgetContentT
ype">LoggerLayout::getContentType()</a></sp
an><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerLayout.html#methodgetFooter&q
uot;>LoggerLayout::getFooter()</a></span><
br>
+ <span
class="method-name"><a
href="../../log4php/LoggerLayout.html#methodgetHeader&q
uot;>LoggerLayout::getHeader()</a></span><
br>
+ </blockquote>
+
+ </div>
+ </div>
+
+
+ <p class="notes" id="credit">
+ Documentation generated on Fri, 20 Jul 2007 22:08:19
-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/layouts/LoggerPattern
Layout.html
URL: http://svn.apache.org/viewvc/incubator/log4php/
site/apidocs/log4php/layouts/LoggerPatternLayout.html?view=a
uto&rev=558223
============================================================
==================
---
incubator/log4php/site/apidocs/log4php/layouts/LoggerPattern
Layout.html (added)
+++
incubator/log4php/site/apidocs/log4php/layouts/LoggerPattern
Layout.html Fri Jul 20 19:10:17 2007
-0,0
+1,483
+<?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
LoggerPatternLayout</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
LoggerPatternLayout</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 flexible
layout configurable with pattern string.</p>
+<p class="description"><p>The goal of
this class is to <a
href="../../log4php/layouts/LoggerPatternLayout.html#me
thodformat">format()</a> a <a
href="../../log4php/spi/LoggerLoggingEvent.html"&g
t;LoggerLoggingEvent</a> and return the results as a
string. The results depend on the conversion pattern. The
conversion pattern is closely related to the conversion
pattern of the printf function in C. A conversion pattern
is composed of literal text and format control expressions
called conversion specifiers. You are free to insert any
literal text within the conversion
pattern.</p><p>Each conversion specifier starts
with a percent sign (%) and is followed by optional format
modifiers and a conversion character.</p><p>The
conversion character specifies the type of data, e.g.
category, priority, date, thread name. The format modifiers
control such things as field width, padding, left and right
justification.</p><p>The following is a simple
example.
+ Let the conversion pattern be "%-5p [%t]:
%m%n" and assume that the log4php environment was
set to use a LoggerPatternLayout.</p><p>Then the
statements <div
class="src-code"><ol><li><div
class="src-line"> <span
class="src-var">$root </span>=&l
t;span
class="src-sym">& </span>
;<span class="src-id"><a
href="../../log4php/LoggerManager.html">LoggerM
anager</a></span><span
class="src-sym">::</span><span
class="src-id">getRoot</span><span
class="src-sym">(</span><span
class="src-sym">)</span><span
class="src-sym">;</span></div></
li>
+<li><div
class="src-line"> <span
class="src-var">$root</span><span
class="src-sym">-></span><span
class="src-id">debug</span><span
class="src-sym">(</span><span
class="src-str">"Message 1&am
p;quot;</span><span
class="src-sym">)</span><span
class="src-sym">;</span></div></
li>
+<li><div
class="src-line"> <span
class="src-var">$root</span><span
class="src-sym">-></span><span
class="src-id">warn</span><span
class="src-sym">(</span><span
class="src-str">"Message 2&am
p;quot;</span><span
class="src-sym">)</span><span
class="src-sym">;</span></div></
li>
+</ol></div> would yield the output <pre>
DEBUG [main]: Message 1
+ WARN [main]: Message 2</pre>
+ Note that there is no explicit separator between text and
conversion specifiers.</p><p>The pattern parser
knows when it has reached the end of a conversion specifier
when it reads a conversion character. In the example above
the conversion specifier %-5p means the priority of the
logging event should be left justified to a width of five
characters.</p><p>Not all log4j conversion
characters are implemented. The recognized conversion
characters
are:<ul><li><strong>c</strong> Used
to output the category of the logging event. The category
conversion specifier can be optionally followed by precision
specifier, that is a decimal constant in brackets.
+ If a precision specifier is given, then only the
corresponding number of right most components of the
category name will be printed.
+ By default the category name is printed in full.
+ For example, for the category name
"a.b.c" the pattern %c will output
"b.c".</li><li><strong>C
</strong> Used to output the fully qualified class
name of the caller issuing the logging request.
+ This conversion specifier can be optionally
followed by precision specifier, that is a decimal constant
in brackets.
+ If a precision specifier is given, then only the
corresponding number of right most components of the class
name will be printed.
+ By default the class name is output in fully
qualified form.
+ For example, for the class name
"org.apache.xyz.SomeClass", the pattern
%C will output
"SomeClass".</li><li><stron
g>d</strong> Used to output the date of the logging
event.
+ The date conversion specifier may be followed by a
date format specifier enclosed between braces.
+ The format specifier follows the <a
href="http://www.php.net/date">http://www.ph
p.net/date</a> function.
+ Note that the special character
<strong>u</strong> is used to as microseconds
replacement (to avoid replacement,
+ use <strong>u</strong>).
+ For example, %d{H:i:s,u} or %d{d M Y H:i:s,u}. If
no date format specifier is given then ISO8601 format is
assumed.
+ The date format specifier admits the same syntax
as the time pattern string of the SimpleDateFormat.
+ It is recommended to use the predefined log4php
date formatters.
+ These can be specified using one of the strings
"ABSOLUTE", "DATE" and
"ISO8601" for specifying
+ AbsoluteTimeDateFormat, DateTimeDateFormat and
respectively ISO8601DateFormat.
+ For example, %d or
%d.</li><li><strong>F</strong
> Used to output the file name where the logging request
was
issued.</li><li><strong>l</strong>
Used to output location information of the caller which
generated the logging
event.</li><li><strong>L</strong>
Used to output the line number from where the logging
request was
issued.</li><li><strong>m</strong>
Used to output the application supplied message associated
with the logging
event.</li><li><strong>M</strong>
Used to output the method name where the logging request was
issued.</li><li><strong>p</strong>
Used to output the priority of the logging
event.</li><li><strong>r</strong>
Used to output the number of milliseconds elapsed since the
start of
+ the application until the creation of the
logging
event.</li><li><strong>t</strong>
Used to output the name of the thread that generated the
logging
event.</li><li><strong>x</strong>
Used to output the NDC (nested diagnostic context)
associated with
+ the thread that generated the logging
event.</li><li><strong>X</strong>
Used to output the MDC (mapped diagnostic context)
associated with
+ the thread that generated the logging event.
+ The X conversion character must be followed by
the key for the map placed between braces,
+ as in <em>%X</em>
where clientNumber is the key.
+ The value in the MDC corresponding to the key
will be output.
+ See <a
href="../../log4php/LoggerMDC.html">LoggerMDC&l
t;/a> class for more
details.</li><li><strong>%</strong>
The sequence %% outputs a single percent
sign.</li></ul> By default the relevant
information is output as is. However, with the aid of
format modifiers it is possible to change the minimum field
width, the maximum field width and
justification.</p><p>The optional format
modifier is placed between the percent sign and the
conversion character.</p><p>The first optional
format modifier is the left justification flag which is just
the minus (-) character. Then comes the optional minimum
field width modifier. This is a decimal constant that
represents the minimum number of characters to output. If
the data item requires fewer characters, it is padded on
either the left or the right until the minimum width is
reached. The default is to pad on the left (right justify)
but you can specify right padding with the left
justification flag. The padding charact
er is space. If the data item is larger than the minimum
field width, the field is expanded to accommodate the data.
The value is never truncated.</p><p>This
behavior can be changed using the maximum field width
modifier which is designated by a period followed by a
decimal constant. If the data item is longer than the
maximum field, then the extra characters are removed from
the beginning of the data item and not from the end. For
example, it the maximum field width is eight and the data
item is ten characters long, then the first two characters
of the data item are dropped. This behavior deviates from
the printf function in C where truncation is done from the
end.</p><p>Below are various format modifier
examples for the category conversion
specifier.</p><p><pre> Format modifier
left justify minimum width maximum width comment
+ %20c false 20 none
Left pad with spaces if the category name
+
is less than 20 characters long.
+ %-20c true 20 none
Right pad with spaces if the category name
+
is less than 20 characters long.
+ %.30c NA none 30
Truncate from the beginning if the category name
+
is longer than 30 characters.
+ %20.30c false 20 30
Left pad with spaces if the category name
+
is shorter than 20 characters.
+
However, if category name is longer than 30 chars,
+
then truncate from the beginning.
+ %-20.30c true 20 30
Right pad with spaces if the category name is
+
shorter than 20 chars.
+
However, if category name is longer than 30 chars,
+
then truncate from the
beginning.</pre></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="_layouts---LoggerPatternLayout.php.html">
/layouts/LoggerPatternLayout.php</a> (line <span
class="field">153</span>)
+ </p>
+
+
+ <pre><a
href="../../log4php/LoggerLayout.html">LoggerLa
yout</a>
+ |
+ --LoggerPatternLayout</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"><a
href="../../log4php/helpers/LoggerPatternConverter.html
">LoggerPatternConverter</a></span>
+ <a href="#$head"
title="details"
class="var-name">$head</a>
+ </div>
+ <div class="var-title">
+ <span
class="var-type">string</span>
+ <a href="#$pattern"
title="details"
class="var-name">$pattern</a>
+ </div>
+ <div class="var-title">
+ <span
class="var-type">string</span>
+ <a href="#$sbuf"
title="details"
class="var-name">$sbuf</a>
+ </div>
+ <div class="var-title">
+ <span
class="var-type">mixed</span>
+ <a href="#$timezone"
title="details"
class="var-name">$timezone</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">LoggerPatternLayout</s
pan>
+ <a href="#LoggerPatternLayout"
title="details"
class="method-name">LoggerPatternLayout</a&g
t;
+ ([<span
class="var-type"></span> <spa
n class="var-name">$pattern</span> =
<span
class="var-default">null</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"><a
href="../../log4php/helpers/LoggerPatternParser.html&qu
ot;>LoggerPatternParser</a></span>
+ <a href="#createPatternParser"
title="details"
class="method-name">createPatternParser</a&g
t;
+ (<span
class="var-type">string</span> &
lt;span
class="var-name">$pattern</span>)
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">string</span>
+ <a href="#format"
title="details"
class="method-name">format</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">string</span>
+ <a href="#getConversionPattern"
title="details"
class="method-name">getConversionPattern</a&
gt;
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#ignoresThrowable"
title="details"
class="method-name">ignoresThrowable</a>
+ ()
+ </div>
+ <div
class="method-definition">
+ <span
class="method-result">void</span>
+ <a href="#setConversionPattern"
title="details"
class="method-name">setConversionPattern</a&
gt;
+ (<span
class="var-type"></span> <spa
n
class="var-name">$conversionPattern</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$head"
id="$head"><!-- --></A>
+<div class="oddrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span class="var-type"><a
href="../../log4php/helpers/LoggerPatternConverter.html
">LoggerPatternConverter</a></span>
+ <span
class="var-name">$head</span>
+ (line <span
class="line-number">168</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">var:</span> head
chain</li>
+ </ul>
+
+
+
+
+
+</div>
+<a name="var$pattern"
id="$pattern"><!-- --></A>
+<div class="evenrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span
class="var-type">string</span>
+ <span
class="var-name">$pattern</span>
+ (line <span
class="line-number">163</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+
+
+
+
+
+</div>
+<a name="var$sbuf"
id="$sbuf"><!-- --></A>
+<div class="oddrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span
class="var-type">string</span>
+ <span
class="var-name">$sbuf</span>
+ (line <span
class="line-number">158</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">var:</span> output buffer
appended to when format() is invoked</li>
+ </ul>
+
+
+
+
+
+</div>
+<a name="var$timezone"
id="$timezone"><!-- --></A>
+<div class="evenrow">
+
+ <div class="var-header">
+ <span class="var-title">
+ <span
class="var-type">mixed</span>
+ <span
class="var-name">$timezone</span>
+ (line <span
class="line-number">170</span>)
+ </span>
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+
+
+
+
+
+</div>
+
+ </div>
+ </div>
+
+ <a name="sec-methods"></a>
+ <div class="info-box">
+ <div
class="info-box-title">Methods</div>
+ <div class="nav-bar">
+ <a
href="#sec-description">Description</a>
|
+ <a
href="#sec-var-summary">Vars</a> (<a
href="#sec-vars">details</a>)
+ <a
href="#sec-method-summary">Methods</a>
(<span
class="disabled">details</span>)
+
+ </div>
+ <div class="info-box-body">
+ <A NAME='method_detail'></A>
+
+<a name="methodLoggerPatternLayout"
id="LoggerPatternLayout"><!--
--></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">Constructor
LoggerPatternLayout</span> (line <span
class="line-number">177</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Constructs a
PatternLayout using the
LOG4PHP_LOGGER_PATTERN_LAYOUT_DEFAULT_LAYOUT_PATTERN.</p&
gt;
+<p class="description"><p>The default
pattern just produces the application supplied
message.</p></p>
+
+ <div class="method-signature">
+ <span
class="method-result">LoggerPatternLayout</s
pan>
+ <span class="method-name">
+ LoggerPatternLayout
+ </span>
+ ([<span
class="var-type"></span> <spa
n class="var-name">$pattern</span> =
<span
class="var-default">null</span>])
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type"></span>
+ <span
class="var-name">$pattern</span> </l
i>
+ </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">209</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Does not do
anything as options become effective</p>
+
+ <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/LoggerLayout.html#methodactivateOpt
ions">LoggerLayout::activateOptions()</a></
dt>
+ <dd>Override this method</dd>
+ </dl>
+
+ </div>
+<a name="methodcreatePatternParser"
id="createPatternParser"><!--
--></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">createPatternParser</sp
an> (line <span
class="line-number">227</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Returns
LoggerPatternParser used to parse the conversion string.
Subclasses may override this to return a subclass of
PatternParser which recognize custom conversion
characters.</p>
+
+ <div class="method-signature">
+ <span class="method-result"><a
href="../../log4php/helpers/LoggerPatternParser.html&qu
ot;>LoggerPatternParser</a></span>
+ <span class="method-name">
+ createPatternParser
+ </span>
+ (<span
class="var-type">string</span> &
lt;span
class="var-name">$pattern</span>)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span
class="var-type">string</span>
+ <span
class="var-name">$pattern</span> </l
i>
+ </ul>
+
+
+ </div>
+<a name="methodformat"
id="format"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">format</span> (line
<span class="line-number">238</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Produces a
formatted string as specified by the conversion
pattern.</p>
+
+ <div class="method-signature">
+ <span
class="method-result">string</span>
+ <span class="method-name">
+ format
+ </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/LoggerLayout.html#methodformat"
;>LoggerLayout::format()</a></dt>
+ <dd>Override this method to create your own
layout format.</dd>
+ </dl>
+
+ </div>
+<a name="methodgetConversionPattern"
id="getConversionPattern"><!--
--></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">getConversionPattern</s
pan> (line <span
class="line-number">201</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+ <ul class="tags">
+ <li><span
class="field">return:</span> Returns the
value of the <strong>ConversionPattern</strong>
option.</li>
+ </ul>
+
+ <div class="method-signature">
+ <span
class="method-result">string</span>
+ <span class="method-name">
+ getConversionPattern
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodignoresThrowable"
id="ignoresThrowable"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span
class="method-title">ignoresThrowable</span&
gt; (line <span
class="line-number">214</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+
+ <div class="method-signature">
+ <span
class="method-result">void</span>
+ <span class="method-name">
+ ignoresThrowable
+ </span>
+ ()
+ </div>
+
+
+
+ </div>
+<a name="methodsetConversionPattern"
id="setConversionPattern"><!--
--></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span
class="method-title">setConversionPattern</s
pan> (line <span
class="line-number">191</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block =========
-->
+<p class="short-description">Set the
<strong>ConversionPattern</strong> option. This
is the string which controls formatting and consists of a
mix of literal content and conversion
specifiers.</p>
+
+ <div class="method-signature">
+ <span
class="method-result">void</span>
+ <span class="method-name">
+ setConversionPattern
+ </span>
+ (<span
class="var-type"></span> <spa
n
class="var-name">$conversionPattern</span>
;)
+ </div>
+
+ <ul class="parameters">
+ <li>
+ <span class="var-type"></span>
+ <span
class="var-name">$conversionPattern</span>
; </li>
+ </ul>
+
+
+ </div>
+ <h4>Inherited Methods</h4>
+ <a name='inherited_methods'><!--
--></a>
+ <!-- =========== Summary =========== -->
+ <p>Inherited From <span
class="classname"><a
href="../../log4php/LoggerLayout.html">LoggerLa
yout</a></span></p>
+ <blockquote>
+ <span
class="method-name"><a
href="../../log4php/LoggerLayout.html#methodactivateOpt
ions">LoggerLayout::activateOptions()</a></
span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerLayout.html#methodfactory&quo
t;>LoggerLayout::factory()</a></span><br&g
t;
+ <span
class="method-name"><a
href="../../log4php/LoggerLayout.html#methodformat"
;>LoggerLayout::format()</a></span><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerLayout.html#methodgetContentT
ype">LoggerLayout::getContentType()</a></sp
an><br>
+ <span
class="method-name"><a
href="../../log4php/LoggerLayout.html#methodgetFooter&q
uot;>LoggerLayout::getFooter()</a></span><
br>
+ <span
class="method-name"><a
href="../../log4php/LoggerLayout.html#methodgetHeader&q
uot;>LoggerLayout::getHeader()</a></span><
br>
+ </blockquote>
+
+ </div>
+ </div>
+
+
+ <p class="notes" id="credit">
+ Documentation generated on Fri, 20 Jul 2007 22:08:21
-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
|
