Docs For Class LoggerAppenderDb

Description

Appends log events to a db table using PEAR::DB class.

Appends log events to a db table using PEAR::DB class. This appender uses a table in a database to log events.

Parameters are $dsn, $createTable, table and $sql.

See examples in test directory.

since: 0.3
version: $Revision: 1.6 $
author: VxR <mailto:vxr@vxr.it>

Located in Program_Root/log4php/appenders/LoggerAppenderDb.php (line 45)

LoggerAppender
   |
   --LoggerAppenderSkeleton
      |
      --LoggerAppenderDb

Variable Summary

boolean $canAppend

boolean $createTable

string $dsn

mixed $requiresLayout

string $sql

string $table

Method Summary

LoggerAppenderDb LoggerAppenderDb (string $name)

boolean activateOptions ()

void append (mixed $event)

void close ()

boolean getCreateTable ()

string getDsn ()

string getSql ()

string getTable ()

void setCreateTable (mixed $flag)

void setDsn (mixed $newDsn)

void setSql (mixed $sql)

void setTable (mixed $table)

Variables

boolean $canAppend = true (line 80)

var: used to check if all conditions to append are true

boolean $createTable = true (line 51)

Create the log table if it does not exists (optional).

string $dsn (line 57)

PEAR::Db Data source name.

PEAR::Db Data source name. Read PEAR::Db for dsn syntax (mandatory).

mixed $requiresLayout = false (line 82)

Redefinition of:

LoggerAppenderSkeleton::$requiresLayout

string $sql (line 63)

A LoggerPatternLayout string used to format a valid insert query (mandatory).

string $table (line 69)

Table name to write events.

Table name to write events. Used only if $createTable is true.

Inherited Variables

Inherited from LoggerAppenderSkeleton

LoggerAppenderSkeleton::$closed
LoggerAppenderSkeleton::$errorHandler
LoggerAppenderSkeleton::$headFilter
LoggerAppenderSkeleton::$layout
LoggerAppenderSkeleton::$name
LoggerAppenderSkeleton::$tailFilter
LoggerAppenderSkeleton::$threshold

Methods

Constructor LoggerAppenderDb (line 89)

Constructor.

LoggerAppenderDb LoggerAppenderDb (string $name)

string $name: appender name

activateOptions (line 100)

Setup db connection.

Setup db connection. Based on defined options, this method connects to db defined in $dsn and creates a $table table if $createTable is true.

return: true if all ok.

boolean activateOptions ()

Redefinition of:

LoggerAppenderSkeleton::activateOptions(): Derived appenders should override this method if option structure requires it.

append (line 134)

void append (mixed $event)

Redefinition of:

LoggerAppenderSkeleton::append(): Subclasses of LoggerAppenderSkeleton should implement this method to perform actual logging.

close (line 146)

void close ()

Redefinition of:

LoggerAppenderSkeleton::close()

getCreateTable (line 156)

boolean getCreateTable ()

getDsn (line 164)

return: the defined dsn

string getDsn ()

getSql (line 172)

return: the sql pattern string

string getSql ()

getTable (line 180)

return: the table name to create

string getTable ()

setCreateTable (line 185)

void setCreateTable (mixed $flag)

setDsn (line 190)

void setDsn (mixed $newDsn)

setSql (line 195)

void setSql (mixed $sql)

setTable (line 200)

void setTable (mixed $table)

Inherited Methods

Inherited From LoggerAppenderSkeleton

LoggerAppenderSkeleton::LoggerAppenderSkeleton()
LoggerAppenderSkeleton::activateOptions()
LoggerAppenderSkeleton::addFilter()
LoggerAppenderSkeleton::append()
LoggerAppenderSkeleton::clearFilters()
LoggerAppenderSkeleton::close()
LoggerAppenderSkeleton::doAppend()
LoggerAppenderSkeleton::finalize()
LoggerAppenderSkeleton::getErrorHandler()
LoggerAppenderSkeleton::getFilter()
LoggerAppenderSkeleton::getFirstFilter()
LoggerAppenderSkeleton::getLayout()
LoggerAppenderSkeleton::getName()
LoggerAppenderSkeleton::getThreshold()
LoggerAppenderSkeleton::isAsSevereAsThreshold()
LoggerAppenderSkeleton::requiresLayout()
LoggerAppenderSkeleton::setErrorHandler()
LoggerAppenderSkeleton::setLayout()
LoggerAppenderSkeleton::setName()
LoggerAppenderSkeleton::setThreshold()
LoggerAppenderSkeleton::__sleep()
LoggerAppenderSkeleton::__wakeup()

Inherited From LoggerAppender

LoggerAppender::addFilter()
LoggerAppender::clearFilters()
LoggerAppender::close()
LoggerAppender::doAppend()
LoggerAppender::factory()
LoggerAppender::getErrorHandler()
LoggerAppender::getFilter()
LoggerAppender::getLayout()
LoggerAppender::getName()
LoggerAppender::requiresLayout()
LoggerAppender::setErrorHandler()
LoggerAppender::setLayout()
LoggerAppender::setName()
LoggerAppender::singleton()