Google Git
Sign in
apache / logging-site / a4f88a44f9ece0268ea2d36ba57a00f2b881cabc / . / content / log4php / 2.2.1 / apidocs / log4php / appenders / LoggerAppenderPDO.html
blob: 5349c9571994ff68094c3712c903a8472f5e4257 [file] [log] [blame]
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs For Class LoggerAppenderPDO</title>
<link rel="stylesheet" href="../../media/stylesheet.css" />
<script src="../../media/lib/classTree.js"></script>
<script language="javascript" type="text/javascript">
var imgPlus = new Image();
var imgMinus = new Image();
imgPlus.src = "../../media/images/plus.png";
imgMinus.src = "../../media/images/minus.png";
function showNode(Node){
switch(navigator.family){
case 'nn4':
// Nav 4.x code fork...
var oTable = document.layers["span" + Node];
var oImg = document.layers["img" + Node];
break;
case 'ie4':
// IE 4/5 code fork...
var oTable = document.all["span" + Node];
var oImg = document.all["img" + Node];
break;
case 'gecko':
// Standards Compliant code fork...
var oTable = document.getElementById("span" + Node);
var oImg = document.getElementById("img" + Node);
break;
}
oImg.src = imgMinus.src;
oTable.style.display = "block";
}
function hideNode(Node){
switch(navigator.family){
case 'nn4':
// Nav 4.x code fork...
var oTable = document.layers["span" + Node];
var oImg = document.layers["img" + Node];
break;
case 'ie4':
// IE 4/5 code fork...
var oTable = document.all["span" + Node];
var oImg = document.all["img" + Node];
break;
case 'gecko':
// Standards Compliant code fork...
var oTable = document.getElementById("span" + Node);
var oImg = document.getElementById("img" + Node);
break;
}
oImg.src = imgPlus.src;
oTable.style.display = "none";
}
function nodeIsVisible(Node){
switch(navigator.family){
case 'nn4':
// Nav 4.x code fork...
var oTable = document.layers["span" + Node];
break;
case 'ie4':
// IE 4/5 code fork...
var oTable = document.all["span" + Node];
break;
case 'gecko':
// Standards Compliant code fork...
var oTable = document.getElementById("span" + Node);
break;
}
return (oTable && oTable.style.display == "block");
}
function toggleNodeVisibility(Node){
if (nodeIsVisible(Node)){
hideNode(Node);
}else{
showNode(Node);
}
}
</script>
</head>
<body>
<div class="page-body">
<h2 class="class-name">Class LoggerAppenderPDO</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Appends log events to a db table using PDO.</p>
<p class="description"><p>Configurable parameters of this appender are:</p><p><ul><li>user - Sets the user of this database connection</li><li>password - Sets the password of this database connection</li><li>createTable - true, if the table should be created if necessary. false otherwise</li><li>table - Sets the table name (default: log4php_log)</li><li>sql - Sets the insert statement for a logging event. Defaults
to the correct one - change only if you are sure what you are doing.</li><li>dsn - Sets the DSN string for this connection</li></ul> If $sql is set then $table and $sql are used, else $table, $insertSql and $insertPattern.</p><p>An example:</p><p><div class="src-code"><ol><li><div class="src-line"><span class="src-inc">require_once&nbsp;</span><span class="src-id">dirname</span><span class="src-sym">(</span>__FILE__<span class="src-sym">)</span>.<span class="src-str">'/../../main/php/Logger.php'</span><span class="src-sym">;</span></div></li>
<li><div class="src-line">&nbsp;</div></li>
<li><div class="src-line"><span class="src-id"><a href="../../log4php/Logger.html">Logger</a></span><span class="src-sym">::</span><a href="../../log4php/Logger.html#methodconfigure">configure</a><span class="src-sym">(</span><a href="http://www.php.net/dirname">dirname</a><span class="src-sym">(</span>__FILE__<span class="src-sym">)</span>.<span class="src-str">'/../resources/appender_pdo.properties'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line"><span class="src-var">$logger&nbsp;</span>=&nbsp;<span class="src-id"><a href="../../log4php/Logger.html">Logger</a></span><span class="src-sym">::</span><a href="../../log4php/Logger.html#methodgetRootLogger">getRootLogger</a><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">$logger</span><span class="src-sym">-&gt;</span><span class="src-id">fatal</span><span class="src-sym">(</span><span class="src-str">&quot;Hello&nbsp;World!&quot;</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
</ol></div></p><p><div class="src-code"><ol><li><div class="src-line">log4php.rootLogger&nbsp;=&nbsp;DEBUG,&nbsp;a1,&nbsp;a2,&nbsp;a3</div></li>
<li><div class="src-line">&nbsp;</div></li>
<li><div class="src-line">;&nbsp;The&nbsp;table&nbsp;is&nbsp;created&nbsp;if&nbsp;necessary&nbsp;and&nbsp;filled&nbsp;using&nbsp;prepared&nbsp;statements.&nbsp;&nbsp;</div></li>
<li><div class="src-line">log4php.appender.a1&nbsp;=&nbsp;LoggerAppenderPDO</div></li>
<li><div class="src-line">log4php.appender.a1.dsn&nbsp;=&nbsp;&quot;sqlite:target/appender_pdo.sqlite&quot;</div></li>
<li><div class="src-line">&nbsp;</div></li>
<li><div class="src-line">;&nbsp;The&nbsp;following&nbsp;shows&nbsp;an&nbsp;appender&nbsp;with&nbsp;customized&nbsp;INSERT&nbsp;statment&nbsp;and&nbsp;table&nbsp;name.&nbsp;</div></li>
<li><div class="src-line">log4php.appender.a2&nbsp;=&nbsp;LoggerAppenderPDO</div></li>
<li><div class="src-line">log4php.appender.a2.user&nbsp;=&nbsp;root</div></li>
<li><div class="src-line">log4php.appender.a2.password&nbsp;=&nbsp;secret</div></li>
<li><div class="src-line">log4php.appender.a2.dsn&nbsp;=&nbsp;&quot;mysql:host=localhost;dbname=test&quot;</div></li>
<li><div class="src-line">log4php.appender.a2.table&nbsp;=&nbsp;log2</div></li>
<li><div class="src-line">log4php.appender.a2.insertSql&nbsp;=&nbsp;&quot;INSERT&nbsp;INTO&nbsp;log2&nbsp;(timestamp,&nbsp;logger,&nbsp;level,&nbsp;message,&nbsp;thread,&nbsp;file,&nbsp;line)&nbsp;VALUES&nbsp;(?,?,?,?,?,?,?)&quot;</div></li>
<li><div class="src-line">log4php.appender.a2.insertPattern&nbsp;=&nbsp;&quot;%d,%c,%p,%m,&nbsp;%t,%F,%L&quot;</div></li>
<li><div class="src-line">&nbsp;</div></li>
<li><div class="src-line">;&nbsp;DEPRECATED:&nbsp;Using&nbsp;old&nbsp;style&nbsp;LoggerPatternLayout&nbsp;is&nbsp;considered&nbsp;unsafe&nbsp;as&nbsp;%m&nbsp;can&nbsp;contain&nbsp;quotes&nbsp;that&nbsp;mess&nbsp;up&nbsp;the&nbsp;SQL!&nbsp;</div></li>
<li><div class="src-line">log4php.appender.a3&nbsp;=&nbsp;LoggerAppenderPDO</div></li>
<li><div class="src-line">log4php.appender.a3.dsn&nbsp;=&nbsp;&quot;sqlite:target/appender_pdo.sqlite&quot;</div></li>
<li><div class="src-line">log4php.appender.a3.table&nbsp;=&nbsp;log3</div></li>
<li><div class="src-line">log4php.appender.a3.sql&nbsp;=&nbsp;&quot;INSERT&nbsp;INTO&nbsp;log3&nbsp;(timestamp,&nbsp;level,&nbsp;message)&nbsp;VALUES&nbsp;('%t',&nbsp;'%p',&nbsp;'%m')&quot;</div></li>
</ol></div></p></p>
<ul class="tags">
<li><span class="field">version:</span> $Revision: 806678 $</li>
<li><span class="field">since:</span> 2.0</li>
</ul>
<p class="notes">
Located in <a class="field" href="_appenders---LoggerAppenderPDO.php.html">/appenders/LoggerAppenderPDO.php</a> (line <span class="field">47</span>)
</p>
<pre><a href="../../log4php/LoggerConfigurable.html">LoggerConfigurable</a>
|
--<a href="../../log4php/LoggerAppender.html">LoggerAppender</a>
|
--LoggerAppenderPDO</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="#$canAppend" title="details" class="var-name">$canAppend</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$createTable" title="details" class="var-name">$createTable</a>
</div>
<div class="var-title">
<span class="var-type">PDO</span>
<a href="#$db" title="details" class="var-name">$db</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$dsn" title="details" class="var-name">$dsn</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$insertPattern" title="details" class="var-name">$insertPattern</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$insertSql" title="details" class="var-name">$insertSql</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$password" title="details" class="var-name">$password</a>
</div>
<div class="var-title">
<span class="var-type">PDOStatement</span>
<a href="#$preparedInsert" title="details" class="var-name">$preparedInsert</a>
</div>
<div class="var-title">
<span class="var-type">mixed</span>
<a href="#$requiresLayout" title="details" class="var-name">$requiresLayout</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$sql" title="details" class="var-name">$sql</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$table" title="details" class="var-name">$table</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$user" title="details" class="var-name">$user</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">boolean</span>
<a href="#activateOptions" title="details" class="method-name">activateOptions</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#append" title="details" class="method-name">append</a>
(<span class="var-type"><a href="../../log4php/LoggerLoggingEvent.html">LoggerLoggingEvent</a></span>&nbsp;<span 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">PDO</span>
<a href="#getDatabaseHandle" title="details" class="method-name">getDatabaseHandle</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setCreateTable" title="details" class="method-name">setCreateTable</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$flag</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setDSN" title="details" class="method-name">setDSN</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$dsn</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setInsertPattern" title="details" class="method-name">setInsertPattern</a>
(<span class="var-type">$pattern</span>&nbsp;<span class="var-name">$pattern</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setInsertSql" title="details" class="method-name">setInsertSql</a>
(<span class="var-type">$sql</span>&nbsp;<span class="var-name">$sql</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setPassword" title="details" class="method-name">setPassword</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$password</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setSql" title="details" class="method-name">setSql</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$sql</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setTable" title="details" class="method-name">setTable</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$table</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#setUser" title="details" class="method-name">setUser</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$user</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$canAppend" id="$canAppend"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">boolean</span>
<span class="var-name">$canAppend</span>
= <span class="var-default"> true</span> (line <span class="line-number">114</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set in activateOptions() and later used in append() to check if all conditions to append are true.</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$createTable" id="$createTable"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$createTable</span>
= <span class="var-default"> true</span> (line <span class="line-number">53</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Create the log table if it does not exists (optional).</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$db" id="$db"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">PDO</span>
<span class="var-name">$db</span>
= <span class="var-default"> null</span> (line <span class="line-number">102</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The PDO instance.</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$dsn" id="$dsn"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$dsn</span>
(line <span class="line-number">71</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">DSN string for enabling a connection.</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$insertPattern" id="$insertPattern"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$insertPattern</span>
= <span class="var-default"> &quot;%d,%c,%p,%m,%t,%F,%L&quot;</span> (line <span class="line-number">90</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">A comma separated list of LoggerPatternLayout format strings that replace the &quot;?&quot; in $sql.</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$insertSql" id="$insertSql"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$insertSql</span>
= <span class="var-default"> &quot;INSERT INTO __TABLE__ (timestamp, logger, level, message, thread, file, line) VALUES (?,?,?,?,?,?,?)&quot;</span> (line <span class="line-number">84</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Can be set to a complete insert statement with ? that are replaced using insertPattern.</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$password" id="$password"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$password</span>
(line <span class="line-number">65</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Database password</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$preparedInsert" id="$preparedInsert"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">PDOStatement</span>
<span class="var-name">$preparedInsert</span>
(line <span class="line-number">108</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Prepared statement for the INSERT INTO query.</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$requiresLayout" id="$requiresLayout"><!-- --></A>
<div class="evenrow">
<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">119</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This appender does not require a layout.</p>
<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/LoggerAppender.html#var$requiresLayout">LoggerAppender::$requiresLayout</a></dt>
<dd>Set to true if the appender requires a layout.</dd>
</dl>
</div>
<a name="var$sql" id="$sql"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$sql</span>
(line <span class="line-number">78</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">A LoggerPatternLayout string used to format a valid insert query.</p>
<ul class="tags">
<li><span class="field">deprecated:</span> Use <a href="../../log4php/appenders/LoggerAppenderPDO.html#var$insertSql">$insertSql</a> and <a href="../../log4php/appenders/LoggerAppenderPDO.html#var$insertPattern">$insertPattern</a> which properly handle quotes in the messages!</li>
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$table" id="$table"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$table</span>
= <span class="var-default"> 'log4php_log'</span> (line <span class="line-number">96</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Table name to write events. Used only for CREATE TABLE if $createTable is true.</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$user" id="$user"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$user</span>
(line <span class="line-number">59</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Database user name.</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<h4>Inherited Variables</h4>
<A NAME='inherited_vars'><!-- --></A>
<p>Inherited from <span class="classname"><a href="../../log4php/LoggerAppender.html">LoggerAppender</a></span></p>
<blockquote>
<span class="var-title">
<span class="var-name"><a href="../../log4php/LoggerAppender.html#var$closed">LoggerAppender::$closed</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../../log4php/LoggerAppender.html#var$filter">LoggerAppender::$filter</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../../log4php/LoggerAppender.html#var$layout">LoggerAppender::$layout</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../../log4php/LoggerAppender.html#var$name">LoggerAppender::$name</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../../log4php/LoggerAppender.html#var$threshold">LoggerAppender::$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> (line <span class="line-number">128</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Setup db connection.</p>
<p class="description"><p>Based on defined options, this method connects to db defined in <a href="../../log4php/appenders/LoggerAppenderPDO.html#var$dsn">$dsn</a> and creates a <a href="../../log4php/appenders/LoggerAppenderPDO.html#var$table">$table</a> table if <a href="../../log4php/appenders/LoggerAppenderPDO.html#var$createTable">$createTable</a> is true.</p></p>
<ul class="tags">
<li><span class="field">return:</span> true if all ok.</li>
<li><span class="field">throws:</span> a PDOException if the attempt to connect to the requested database fails.</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
activateOptions
</span>
()
</div>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../../log4php/LoggerAppender.html#methodactivateOptions">LoggerAppender::activateOptions()</a></dt>
<dd>Prepares the appender for logging.</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">191</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Appends a new event to the database.</p>
<ul class="tags">
<li><span class="field">throws:</span> LoggerException If the pattern conversion or the INSERT statement fails.</li>
<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"><a href="../../log4php/LoggerLoggingEvent.html">LoggerLoggingEvent</a></span>&nbsp;<span class="var-name">$event</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"><a href="../../log4php/LoggerLoggingEvent.html">LoggerLoggingEvent</a></span>
<span class="var-name">$event</span> </li>
</ul>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../../log4php/LoggerAppender.html#methodappend">LoggerAppender::append()</a></dt>
<dd>Forwards the logging event to the destination.</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">213</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Closes the connection to the logging database</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">
close
</span>
()
</div>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../../log4php/LoggerAppender.html#methodclose">LoggerAppender::close()</a></dt>
<dd>Releases any resources allocated by the appender.</dd>
</dl>
</div>
<a name="methodgetDatabaseHandle" id="getDatabaseHandle"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">getDatabaseHandle</span> (line <span class="line-number">306</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sometimes databases allow only one connection to themselves in one thread.</p>
<p class="description"><p>SQLite has this behaviour. In that case this handle is needed if the database must be checked for events.</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">PDO</span>
<span class="method-name">
getDatabaseHandle
</span>
()
</div>
</div>
<a name="methodsetCreateTable" id="setCreateTable"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">setCreateTable</span> (line <span class="line-number">242</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Indicator if the logging table should be created on startup, if its not existing.</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">
setCreateTable
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$flag</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$flag</span> </li>
</ul>
</div>
<a name="methodsetDSN" id="setDSN"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">setDSN</span> (line <span class="line-number">295</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the DSN string for this connection. In case of</p>
<p class="description"><p>SQLite it could look like this: 'sqlite:appenders/pdotest.sqlite'</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">
setDSN
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$dsn</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$dsn</span> </li>
</ul>
</div>
<a name="methodsetInsertPattern" id="setInsertPattern"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">setInsertPattern</span> (line <span class="line-number">279</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the <a href="../../log4php/layouts/LoggerLayoutPattern.html">LoggerLayoutPattern</a> format strings for $insertSql.</p>
<p class="description"><p>It's not necessary to change this except you have customized logging.</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">
setInsertPattern
</span>
(<span class="var-type">$pattern</span>&nbsp;<span class="var-name">$pattern</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">$pattern</span>
<span class="var-name">$pattern</span><span class="var-description">: Comma separated format strings like &quot;%p,%m,%C&quot;</span> </li>
</ul>
</div>
<a name="methodsetInsertSql" id="setInsertSql"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">setInsertSql</span> (line <span class="line-number">268</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the SQL INSERT string to use with $insertPattern.</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">
setInsertSql
</span>
(<span class="var-type">$sql</span>&nbsp;<span class="var-name">$sql</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">$sql</span>
<span class="var-name">$sql</span><span class="var-description">: A complete INSERT INTO query with &quot;?&quot; that gets replaced.</span> </li>
</ul>
</div>
<a name="methodsetPassword" id="setPassword"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">setPassword</span> (line <span class="line-number">234</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the password for this connection.</p>
<p class="description"><p>Defaults to ''</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">
setPassword
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$password</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$password</span> </li>
</ul>
</div>
<a name="methodsetSql" id="setSql"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">setSql</span> (line <span class="line-number">259</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the SQL string into which the event should be transformed.</p>
<p class="description"><p>Defaults to:</p><p>INSERT INTO $this-&gt;table ( timestamp, logger, level, message, thread, file, line) VALUES ('%d','%c','%p','%m','%t','%F','%L')</p><p>It's not necessary to change this except you have customized logging'</p></p>
<ul class="tags">
<li><span class="field">deprecated:</span> See <a href="../../log4php/appenders/LoggerAppenderPDO.html#methodsetInsertSql">setInsertSql</a> and <a href="../../log4php/appenders/LoggerAppenderPDO.html#methodsetInsertPattern">setInsertPattern</a>.</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
setSql
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$sql</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$sql</span> </li>
</ul>
</div>
<a name="methodsetTable" id="setTable"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">setTable</span> (line <span class="line-number">287</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the tablename to which this appender should log.</p>
<p class="description"><p>Defaults to log4php_log</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">
setTable
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$table</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$table</span> </li>
</ul>
</div>
<a name="methodsetUser" id="setUser"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">setUser</span> (line <span class="line-number">226</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the username for this connection.</p>
<p class="description"><p>Defaults to ''</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">
setUser
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$user</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$user</span> </li>
</ul>
</div>
<h4>Inherited Methods</h4>
<a name='inherited_methods'><!-- --></a>
<!-- =========== Summary =========== -->
<p>Inherited From <span class="classname"><a href="../../log4php/LoggerAppender.html">LoggerAppender</a></span></p>
<blockquote>
<span class="method-name"><a href="../../log4php/LoggerAppender.html#method__construct">LoggerAppender::__construct()</a></span><br>
<span class="method-name"><a href="../../log4php/LoggerAppender.html#methodactivateOptions">LoggerAppender::activateOptions()</a></span><br>
<span class="method-name"><a href="../../log4php/LoggerAppender.html#methodaddFilter">LoggerAppender::addFilter()</a></span><br>
<span class="method-name"><a href="../../log4php/LoggerAppender.html#methodappend">LoggerAppender::append()</a></span><br>
<span class="method-name"><a href="../../log4php/LoggerAppender.html#methodclearFilters">LoggerAppender::clearFilters()</a></span><br>
<span class="method-name"><a href="../../log4php/LoggerAppender.html#methodclose">LoggerAppender::close()</a></span><br>
<span class="method-name"><a href="../../log4php/LoggerAppender.html#methoddoAppend">LoggerAppender::doAppend()</a></span><br>
<span class="method-name"><a href="../../log4php/LoggerAppender.html#methodgetDefaultLayout">LoggerAppender::getDefaultLayout()</a></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#methodgetFirstFilter">LoggerAppender::getFirstFilter()</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">LoggerAppender::getName()</a></span><br>
<span class="method-name"><a href="../../log4php/LoggerAppender.html#methodgetThreshold">LoggerAppender::getThreshold()</a></span><br>
<span class="method-name"><a href="../../log4php/LoggerAppender.html#methodisAsSevereAsThreshold">LoggerAppender::isAsSevereAsThreshold()</a></span><br>
<span class="method-name"><a href="../../log4php/LoggerAppender.html#methodrequiresLayout">LoggerAppender::requiresLayout()</a></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">LoggerAppender::setName()</a></span><br>
<span class="method-name"><a href="../../log4php/LoggerAppender.html#methodsetThreshold">LoggerAppender::setThreshold()</a></span><br>
<span class="method-name"><a href="../../log4php/LoggerAppender.html#methodwarn">LoggerAppender::warn()</a></span><br>
</blockquote>
<!-- =========== Summary =========== -->
<p>Inherited From <span class="classname"><a href="../../log4php/LoggerConfigurable.html">LoggerConfigurable</a></span></p>
<blockquote>
<span class="method-name"><a href="../../log4php/LoggerConfigurable.html#methodsetBoolean">LoggerConfigurable::setBoolean()</a></span><br>
<span class="method-name"><a href="../../log4php/LoggerConfigurable.html#methodsetFileSize">LoggerConfigurable::setFileSize()</a></span><br>
<span class="method-name"><a href="../../log4php/LoggerConfigurable.html#methodsetInteger">LoggerConfigurable::setInteger()</a></span><br>
<span class="method-name"><a href="../../log4php/LoggerConfigurable.html#methodsetLevel">LoggerConfigurable::setLevel()</a></span><br>
<span class="method-name"><a href="../../log4php/LoggerConfigurable.html#methodsetNumeric">LoggerConfigurable::setNumeric()</a></span><br>
<span class="method-name"><a href="../../log4php/LoggerConfigurable.html#methodsetPositiveInteger">LoggerConfigurable::setPositiveInteger()</a></span><br>
<span class="method-name"><a href="../../log4php/LoggerConfigurable.html#methodsetString">LoggerConfigurable::setString()</a></span><br>
<span class="method-name"><a href="../../log4php/LoggerConfigurable.html#methodwarn">LoggerConfigurable::warn()</a></span><br>
</blockquote>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Sat, 18 Feb 2012 22:32:22 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>