Docs For Class LoggerAppenderSkeleton

Class LoggerAppenderSkeleton

Description

Abstract superclass of the other appenders in the package.

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.

abstract:
version: $Revision: 1.15 $
author: Sergio Strampelli <mailto:sergio@ascia.net>
author: VxR <mailto:vxr@vxr.it>

Located in Program_Root/log4php/LoggerAppenderSkeleton.php (line 42)

LoggerAppender
   |
   --LoggerAppenderSkeleton

Direct descendents

Class	Description
LoggerAppenderConsole	ConsoleAppender appends log events to STDOUT or STDERR using a layout specified by the user.
LoggerAppenderDb	Appends log events to a db table using PEAR::DB class.
LoggerAppenderEcho	LoggerAppenderEcho uses http://www.php.net/echo function to output events.
LoggerAppenderFile	FileAppender appends log events to a file.
LoggerAppenderMail	Appends log events to mail using php function http://www.php.net/mail.
LoggerAppenderMailEvent	Log events to an email address.
LoggerAppenderNull	A NullAppender merely exists, it never outputs a message to any device.
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.
LoggerAppenderSyslog	Log events using php http://www.php.net/syslog function.

Variable Summary

boolean $closed

object unused $errorHandler

LoggerFilter $headFilter

LoggerLayout $layout

string $name

boolean $requiresLayout

LoggerFilter $tailFilter

LoggerLevel $threshold

Method Summary

LoggerAppenderSkeleton LoggerAppenderSkeleton (string $name)

void activateOptions ()

void addFilter (LoggerFilter $newFilter)

void append (LoggerLoggingEvent $event)

void clearFilters ()

void close ()

void doAppend (LoggerLoggingEvent $event)

void finalize ()

object &getErrorHandler ()

Filter &getFilter ()

Filter &getFirstFilter ()

LoggerLayout &getLayout ()

string getName ()

LoggerLevel &getThreshold ()

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 (line 47)

var: closed appender flag

object unused $errorHandler (line 52)

LoggerFilter $headFilter = null (line 58)

The first filter in the filter chain

LoggerLayout $layout = null (line 64)

LoggerLayout for this appender.

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

string $name (line 69)

var: Appender name

boolean $requiresLayout = false (line 85)

var: needs a layout formatting ?

LoggerFilter $tailFilter = null (line 75)

The last filter in the filter chain

LoggerLevel $threshold = null (line 80)

var: There is no level threshold filtering by default.

Methods

Constructor LoggerAppenderSkeleton (line 96)

Constructor

LoggerAppenderSkeleton LoggerAppenderSkeleton (string $name)

string $name: appender name

activateOptions (line 121)

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

void activateOptions ()

Redefined in descendants as:

LoggerAppenderConsole::activateOptions()
LoggerAppenderDb::activateOptions() : Setup db connection.
LoggerAppenderEcho::activateOptions()
LoggerAppenderFile::activateOptions()
LoggerAppenderMail::activateOptions()
LoggerAppenderMailEvent::activateOptions()
LoggerAppenderNull::activateOptions()
LoggerAppenderPhp::activateOptions()
LoggerAppenderSocket::activateOptions() : Create a socket connection using defined parameters
LoggerAppenderSyslog::activateOptions()

addFilter (line 106)

see: LoggerAppender::addFilter()

void addFilter (LoggerFilter $newFilter)

LoggerFilter $newFilter: add a new LoggerFilter

Redefinition of:

LoggerAppender::addFilter(): Add a filter to the end of the filter list.

append (line 134)

Subclasses of LoggerAppenderSkeleton should implement this method to perform actual logging.

abstract:
see: LoggerAppenderSkeleton::doAppend()

void append (LoggerLoggingEvent $event)

LoggerLoggingEvent $event

Redefined in descendants as:

clearFilters (line 142)

see: LoggerAppender::clearFilters()

void clearFilters ()

Redefinition of:

LoggerAppender::clearFilters(): Clear the list of filters by removing all the filters in it.

close (line 153)

see: LoggerAppender::close()

void close ()

Redefinition of:

LoggerAppender::close(): Release any resources allocated.

Redefined in descendants as:

doAppend (line 249)

see: LoggerAppender::doAppend()

void doAppend (LoggerLoggingEvent $event)

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

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

void finalize ()

getErrorHandler (line 177)

Do not use this method.

see: LoggerAppender::getErrorHandler()

object &getErrorHandler ()

Redefinition of:

LoggerAppender::getErrorHandler(): Do not use this method.

getFilter (line 186)

see: LoggerAppender::getFilter()

Filter &getFilter ()

Redefinition of:

LoggerAppender::getFilter(): Return the first filter in the filter chain for this Appender.

getFirstFilter (line 196)

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

Return the first filter in the filter chain for this Appender. The return value may be null if no is filter is set.

Filter &getFirstFilter ()

getLayout (line 205)

see: LoggerAppender::getLayout()

LoggerLayout &getLayout ()

Redefinition of:

LoggerAppender::getLayout(): Returns this appender layout.

getName (line 214)

see: LoggerAppender::getName()

string getName ()

Redefinition of:

LoggerAppender::getName(): Get the name of this appender.

getThreshold (line 224)

Returns this appenders threshold level.

Returns this appenders threshold level. See the setThreshold() method for the meaning of this option.

LoggerLevel &getThreshold ()

isAsSevereAsThreshold (line 237)

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

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

boolean isAsSevereAsThreshold (LoggerLevel $priority)

LoggerLevel $priority

requiresLayout (line 279)

see: LoggerAppender::requiresLayout()

boolean requiresLayout ()

Redefinition of:

LoggerAppender::requiresLayout(): Configurators call this method to determine if the appender requires a layout.

setErrorHandler (line 288)

see: LoggerAppender::setErrorHandler()

void setErrorHandler (object $errorHandler)

object $errorHandler

Redefinition of:

LoggerAppender::setErrorHandler(): Do not use this method.

setLayout (line 303)

see: LoggerAppender::setLayout()

void setLayout (LoggerLayout $layout)

LoggerLayout $layout

Redefinition of:

LoggerAppender::setLayout(): Set the Layout for this appender.

setName (line 313)

see: LoggerAppender::setName()

void setName (string $name)

string $name

Redefinition of:

LoggerAppender::setName(): Set the name of this appender.

setThreshold (line 324)

Set the threshold level of this appender.

see: LoggerOptionConverter::toLevel()

void setThreshold (mixed $threshold)

mixed $threshold: can be a LoggerLevel object or a string.

__sleep (line 338)

Perform actions before object serialization.

Perform actions before object serialization. Call finalize() to properly close the appender.

void __sleep ()

__wakeup (line 349)

Perform actions after object deserialization.

Perform actions after object deserialization. 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 on Mon, 1 Dec 2003 22:09:42 +0100 by phpDocumentor 1.2.2