Docs For Class LoggerAppender

Class LoggerAppender

Description

Abstract class that defines output logs strategies.

abstract:
version: $Revision: 1.14 $
author: VxR <mailto:vxr@vxr.it>

Located in Program_Root/log4php/LoggerAppender.php (line 32)

Direct descendents

Class	Description
LoggerAppenderSkeleton	Abstract superclass of the other appenders in the package.

Method Summary

void addFilter (LoggerFilter $newFilter)

void clearFilters ()

void close ()

void doAppend (LoggerLoggingEvent $event)

LoggerAppender factory (string $name, string $class)

object Returns &getErrorHandler ()

Filter &getFilter ()

LoggerLayout &getLayout ()

string getName ()

boolean requiresLayout ()

void setErrorHandler (object $errorHandler)

void setLayout (LoggerLayout $layout)

void setName (string $name)

LoggerAppender &singleton (string $name, [string $class = ''])

Methods

addFilter (line 90)

Add a filter to the end of the filter list.

abstract:

void addFilter (LoggerFilter $newFilter)

LoggerFilter $newFilter: add a new LoggerFilter

Redefined in descendants as:

LoggerAppenderSkeleton::addFilter()

clearFilters (line 99)

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

abstract:

void clearFilters ()

Redefined in descendants as:

LoggerAppenderSkeleton::clearFilters()

close (line 120)

Release any resources allocated.

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

abstract:

void close ()

Redefined in descendants as:

doAppend (line 131)

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

abstract:

void doAppend (LoggerLoggingEvent $event)

LoggerLoggingEvent $event

Redefined in descendants as:

LoggerAppenderSkeleton::doAppend()

factory (line 41)

Factory

LoggerAppender factory (string $name, string $class)

string $name: appender name
string $class: create an instance of this appender class

getErrorHandler (line 159)

Do not use this method.

return: the ErrorHandler for this appender.

object Returns &getErrorHandler ()

Redefined in descendants as:

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

getFilter (line 109)

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 &getFilter ()

Redefined in descendants as:

LoggerAppenderSkeleton::getFilter()

getLayout (line 178)

Returns this appender layout.

LoggerLayout &getLayout ()

Redefined in descendants as:

LoggerAppenderSkeleton::getLayout()

getName (line 140)

Get the name of this appender.

string getName ()

Redefined in descendants as:

LoggerAppenderSkeleton::getName()

requiresLayout (line 212)

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

Configurators call this method to determine if the appender requires a layout. If this method returns true, meaning that layout is required, then the configurator will configure a layout using the configuration information at its disposal. If this method returns false, meaning that a layout is not required, then layout configuration will be skipped even if there is available layout configuration information at the disposal of the configurator.

In the rather exceptional case, where the appender implementation admits a layout but can also work without it, then the appender should return true.

boolean requiresLayout ()

Redefined in descendants as: