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

Located in Program_Root/src/log4php/LoggerAppenderSkeleton.php (line 35)

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	Log events to a network socket.
LoggerAppenderSyslog	Log events using php http://www.php.net/syslog function.

Variable Summary

boolean $closed

object unused $errorHandler

object The $headFilter

object {@link $layout

string $name

boolean $requiresLayout

object The $tailFilter

integer $threshold

Method Summary

LoggerAppenderSkeleton LoggerAppenderSkeleton (string $name)

void activateOptions ()

void addFilter (object $newFilter)

void append (mixed $event)

void clearFilters ()

void close ()

void doAppend (object $event)

void finalize ()

object Returns &getErrorHandler ()

object returns &getFilter ()

void &getFirstFilter ()

object {@link &getLayout ()

string getName ()

void getThreshold ()

boolean isAsSevereAsThreshold (mixed $priority)

void requiresLayout ()

void setErrorHandler (mixed $errorHandler)

void setLayout (object $layout)

void setName (string $name)

void setThreshold (string $threshold)

Variables

boolean $closed (line 40)

var: closed appender flag

object unused $errorHandler (line 45)

object The $headFilter = null (line 50)

var: first filter in the filter chain

object {@link $layout = null (line 55)

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

string $name (line 60)

var: Appender name

boolean $requiresLayout = false (line 75)

var: needs a layout formatting ?

Redefined in descendants as:

object The $tailFilter = null (line 65)

var: last filter in the filter chain

integer $threshold (line 70)

var: There is no level threshold filtering by default.

Methods

Constructor LoggerAppenderSkeleton (line 86)

Constructor

LoggerAppenderSkeleton LoggerAppenderSkeleton (string $name)

string $name: appender name

activateOptions (line 108)

void activateOptions ()

Redefined in descendants as:

LoggerAppenderConsole::activateOptions()
LoggerAppenderDb::activateOptions()
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 97)

Add a filter to the end of the filter list.

void addFilter (object $newFilter)

object $newFilter: a LoggerFilter to add

append (line 119)

Subclasses of


1     LoggerAppenderSkeleton

should implement this method to perform actual logging.

Subclasses of


1     LoggerAppenderSkeleton

should implement this method to perform actual logging.

see: LoggerAppenderSkeleton::doAppend()

void append (mixed $event)

Redefined in descendants as:

clearFilters (line 127)

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

void clearFilters ()

close (line 136)

Release any resources allocated.

void close ()

Redefined in descendants as:

doAppend (line 223)

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

void doAppend (object $event)

object $event: a LoggerEvent

Redefined in descendants as:

LoggerAppenderNull::doAppend() : Does not do anything.

finalize (line 147)

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

return: the ErrorHandler for this appender.

object Returns &getErrorHandler ()

getFilter (line 167)

return: the head Filter.

object returns &getFilter ()

getFirstFilter (line 176)

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.

void &getFirstFilter ()

getLayout (line 185)

Returns this appender layout.

return: LoggerLayout}

object {@link &getLayout ()

getName (line 194)

Get the name of this appender.

string getName ()

getThreshold (line 203)

Returns this appenders threshold level.

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

void getThreshold ()

isAsSevereAsThreshold (line 213)

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

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

void requiresLayout ()

setErrorHandler (line 258)

Set the ErrorHandler for this appender.

void setErrorHandler (mixed $errorHandler)

setLayout (line 274)

Set the Layout for this appender.

void setLayout (object $layout)

object $layout: a LoggerLayout

setName (line 285)

Set the name of this appender.

void setName (string $name)

string $name: appender name

setThreshold (line 295)

Set the threshold level of this appender.

void setThreshold (string $threshold)

string $threshold: appender threshold

Documentation generated on Wed, 27 Aug 2003 18:11:34 +0200 by phpDocumentor 1.2.2