Class LoggerAppenderSkeleton

Description

Abstract superclass of the other appenders in the package.

This class provides the code for common functionality, such as support for threshold filtering and support for general filters.

  • author: Sergio Strampelli
  • author: Marco Vassura
  • version: $Revision: 556784 $
  • abstract:

Located in /LoggerAppenderSkeleton.php (line 35)

LoggerAppender
   |
   --LoggerAppenderSkeleton
Direct descendents
Class Description
LoggerAppenderConsole ConsoleAppender appends log events to STDOUT or STDERR using a layout specified by the user.
LoggerAppenderNull A NullAppender merely exists, it never outputs a message to any device.
LoggerAppenderEcho LoggerAppenderEcho uses echo function to output events.
LoggerAppenderFile FileAppender appends log events to a file.
LoggerAppenderSyslog Log events using php http://www.php.net/syslog function.
LoggerAppenderMail Appends log events to mail using php function http://www.php.net/mail.
LoggerAppenderMailEvent Log events to an email address. It will be created an email for each event.
LoggerAppenderDb Appends log events to a db table using PEAR::DB class.
LoggerAppenderPhp Log events using php http://www.php.net/trigger_error function and a LoggerLayoutTTCC default layout.
LoggerAppenderSocket Serialize events and send them to a network socket.
LoggerAppenderAdodb Appends log events to a db table using adodb class.
Variable Summary
Method Summary
LoggerAppenderSkeleton __construct (string $name)
void activateOptions ()
void addFilter (LoggerFilter $newFilter)
void append (LoggerLoggingEvent $event)
void clearFilters ()
void doAppend (LoggerLoggingEvent $event)
void finalize ()
object getErrorHandler ()
string getName ()
boolean isAsSevereAsThreshold (LoggerLevel $priority)
boolean requiresLayout ()
void setErrorHandler (object $errorHandler)
void setLayout (LoggerLayout $layout)
void setName (string $name)
void setThreshold (mixed $threshold)
void __sleep ()
void __wakeup ()
Variables
boolean $closed = false (line 40)
  • var: closed appender flag
  • access: protected
object unused $errorHandler (line 45)
  • access: protected
LoggerFilter $headFilter = null (line 51)

The first filter in the filter chain

  • access: protected
LoggerLayout $layout = null (line 57)

LoggerLayout for this appender. It can be null if appender has its own layout

  • access: protected
string $name (line 62)
  • var: Appender name
  • access: protected
boolean $requiresLayout = false (line 78)
  • var: needs a layout formatting ?
  • access: protected

Redefined in descendants as:
LoggerFilter $tailFilter = null (line 68)

The last filter in the filter chain

  • access: protected
LoggerLevel $threshold = null (line 73)
  • var: There is no level threshold filtering by default.
  • access: protected
Methods
Constructor __construct (line 85)

Constructor

  • access: public
LoggerAppenderSkeleton __construct (string $name)
  • string $name: appender name

Redefined in descendants as:
activateOptions (line 108)

Derived appenders should override this method if option structure requires it.

  • abstract:
  • access: public
void activateOptions ()

Redefined in descendants as:
addFilter (line 94)
void addFilter (LoggerFilter $newFilter)

Redefinition of:
LoggerAppender::addFilter()
Add a filter to the end of the filter list.
clearFilters (line 123)
void clearFilters ()

Redefinition of:
LoggerAppender::clearFilters()
Clear the list of filters by removing all the filters in it.
doAppend (line 222)
void doAppend (LoggerLoggingEvent $event)

Redefinition of:
LoggerAppender::doAppend()
This method performs threshold checks and invokes filters before delegating actual logging to the subclasses specific append() method.
finalize (line 134)

Finalize this appender by calling the derived class' close() method.

  • access: public
void finalize ()
getErrorHandler (line 150)

Do not use this method.

object getErrorHandler ()

Redefinition of:
LoggerAppender::getErrorHandler()
Do not use this method.
getFilter (line 159)
LoggerFilter getFilter ()

Redefinition of:
LoggerAppender::getFilter()
Return the first filter in the filter chain for this Appender.
getFirstFilter (line 169)

Return the first filter in the filter chain for this Appender.

The return value may be null if no is filter is set.

  • access: public
LoggerFilter getFirstFilter ()
getLayout (line 178)
LoggerLayout getLayout ()

Redefinition of:
LoggerAppender::getLayout()
Returns this appender layout.
getName (line 187)
string getName ()

Redefinition of:
LoggerAppender::getName()
Get the name of this appender.
getThreshold (line 197)

Returns this appenders threshold level.

See the setThreshold() method for the meaning of this option.

  • access: public
LoggerLevel getThreshold ()
isAsSevereAsThreshold (line 210)

Check whether the message level is below the appender's threshold.

If there is no threshold set, then the return value is always true.

  • return: true if priority is greater or equal than threshold
  • access: public
boolean isAsSevereAsThreshold (LoggerLevel $priority)
requiresLayout (line 252)
boolean requiresLayout ()

Redefinition of:
LoggerAppender::requiresLayout()
Configurators call this method to determine if the appender requires a layout.
setErrorHandler (line 261)
void setErrorHandler (object $errorHandler)
  • object $errorHandler

Redefinition of:
LoggerAppender::setErrorHandler()
Do not use this method.
setLayout (line 276)
void setLayout (LoggerLayout $layout)

Redefinition of:
LoggerAppender::setLayout()
Set the Layout for this appender.
setName (line 286)
void setName (string $name)
  • string $name

Redefinition of:
LoggerAppender::setName()
Set the name of this appender.
setThreshold (line 297)

Set the threshold level of this appender.

void setThreshold (mixed $threshold)
  • mixed $threshold: can be a LoggerLevel object or a string.
__sleep (line 311)

Perform actions before object serialization.

Call finalize() to properly close the appender.

void __sleep ()
__wakeup (line 322)

Perform actions after object de-serialization.

Call activateOptions() to properly setup the appender.

void __wakeup ()

Inherited Methods

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