Class LoggerAppenderDb

Description

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.

  • author: Marco Vassura
  • version: $Revision: 556784 $
  • since: 0.3

Located in /appenders/LoggerAppenderDb.php (line 36)

LoggerAppender
   |
   --LoggerAppenderSkeleton
      |
      --LoggerAppenderDb
Variable Summary
boolean $createTable
string $dsn
string $sql
string $table
Method Summary
LoggerAppenderDb LoggerAppenderDb (string $name)
boolean activateOptions ()
void append ( $event)
void close ()
boolean getCreateTable ()
string getDsn ()
string getSql ()
string getTable ()
void setCreateTable ( $flag)
void setDsn ( $newDsn)
void setSql ( $sql)
void setTable ( $table)
Variables
boolean $createTable = true (line 42)

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

string $dsn (line 48)

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

string $sql (line 54)

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

string $table (line 60)

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 84)

Constructor.

LoggerAppenderDb LoggerAppenderDb (string $name)
  • string $name: appender name
activateOptions (line 95)

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 131)
void append ( $event)
  • $event

Redefinition of:
LoggerAppenderSkeleton::append()
Subclasses of LoggerAppenderSkeleton should implement this method to perform actual logging.
close (line 143)
void close ()

Redefinition of:
LoggerAppender::close()
Release any resources allocated.
getCreateTable (line 153)
boolean getCreateTable ()
getDsn (line 161)
  • return: the defined dsn
string getDsn ()
getSql (line 169)
  • return: the sql pattern string
string getSql ()
getTable (line 177)
  • return: the table name to create
string getTable ()
setCreateTable (line 182)
void setCreateTable ( $flag)
  • $flag
setDsn (line 187)
void setDsn ( $newDsn)
  • $newDsn
setSql (line 192)
void setSql ( $sql)
  • $sql
setTable (line 197)
void setTable ( $table)
  • $table

Inherited Methods

Inherited From LoggerAppenderSkeleton

LoggerAppenderSkeleton::__construct()
LoggerAppenderSkeleton::activateOptions()
LoggerAppenderSkeleton::addFilter()
LoggerAppenderSkeleton::append()
LoggerAppenderSkeleton::clearFilters()
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()

Documentation generated by phpDocumentor 1.3.2