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.6 $
author: Sergio Strampelli <mailto:sergio@ascia.net>
author: VxR <mailto:vxr@vxr.it>

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

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

integer $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 Returns &getErrorHandler ()

Filter &getFilter ()

Filter &getFirstFilter ()

LoggerLayout &getLayout ()

string getName ()

void getThreshold ()

boolean isAsSevereAsThreshold (mixed $priority)

boolean requiresLayout ()

void setErrorHandler (object $errorHandler)

void setLayout (LoggerLayout $layout)

void setName (string $name)

void setThreshold (mixed $threshold)

Variables

boolean $closed (line 50)

var: closed appender flag

object unused $errorHandler (line 55)

LoggerFilter $headFilter = null (line 61)

The first filter in the filter chain

LoggerLayout $layout = null (line 67)

LoggerLayout for this appender.

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

string $name (line 72)

var: Appender name

boolean $requiresLayout = false (line 88)

var: needs a layout formatting ?

Redefined in descendants as:

LoggerFilter $tailFilter = null (line 78)

The last filter in the filter chain

integer $threshold (line 83)

var: There is no level threshold filtering by default.

Methods

Constructor LoggerAppenderSkeleton (line 99)

Constructor

LoggerAppenderSkeleton LoggerAppenderSkeleton (string $name)

string $name: appender name

activateOptions (line 127)

Called after the appender paramters are set with setter methods.

Called after the appender paramters are set with setter methods. Subclasses of LoggerAppenderSkeleton should implement this method to perform proper options setup. By default id does nothing.

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

Add a filter to the end of the filter list.

void addFilter (LoggerFilter $newFilter)

LoggerFilter $newFilter: add a new LoggerFilter

append (line 138)

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

see: LoggerAppenderSkeleton::doAppend()

void append (LoggerLoggingEvent $event)

LoggerLoggingEvent $event

Redefined in descendants as:

clearFilters (line 146)

Clear the list of filters by removing all the filters in it.

void clearFilters ()

close (line 157)

Release any resources allocated.

Release any resources allocated. Subclasses of LoggerAppenderSkeleton should implement this method to perform proper closing procedures.

void close ()

Redefined in descendants as:

doAppend (line 246)

This method performs threshold checks and invokes filters before delegating actual logging to the subclasses specific append() method.

void doAppend (LoggerLoggingEvent $event)

LoggerLoggingEvent $event

finalize (line 166)

Finalize this appender by calling the derived class'


1     close

method.

Finalize this appender by calling the derived class'


1     close

method.

void finalize ()

getErrorHandler (line 179)

Do not use this method.

return: the ErrorHandler for this appender.

object Returns &getErrorHandler ()

getFilter (line 189)

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


1     null

if no is filter is set.

Filter &getFilter ()

getFirstFilter (line 199)

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


1     null

if no is filter is set.

Filter &getFirstFilter ()

getLayout (line 208)

Returns this appender layout.

LoggerLayout &getLayout ()

getName (line 217)

Get the name of this appender.

string getName ()

getThreshold (line 226)

Returns this appenders threshold level.

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

void getThreshold ()

isAsSevereAsThreshold (line 236)

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


1     true

boolean isAsSevereAsThreshold (mixed $priority)

requiresLayout (line 274)

Configurators call this method to determine if the appender requires a layout.

boolean requiresLayout ()

setErrorHandler (line 284)

Set the ErrorHandler for this appender.

void setErrorHandler (object $errorHandler)

object $errorHandler

setLayout (line 300)

Set the Layout for this appender.

void setLayout (LoggerLayout $layout)

LoggerLayout $layout

setName (line 311)

Set the name of this appender.

void setName (string $name)

string $name

setThreshold (line 321)

Set the threshold level of this appender.

void setThreshold (mixed $threshold)

mixed $threshold: a string representation of a level or a level constant.

Inherited Methods

Inherited From LoggerAppender

LoggerAppender::factory()
LoggerAppender::singleton()

Documentation generated on Wed, 3 Sep 2003 01:02:24 +0200 by phpDocumentor 1.2.2