Class LoggerAppender

Description

Abstract class that defines output logs strategies.

  • author: Marco Vassura
  • version: $Revision: 556801 $
  • abstract:

Located in /LoggerAppender.php (line 24)


	
			
Direct descendents
Class Description
LoggerAppenderSkeleton Abstract superclass of the other appenders in the package.
Method Summary
static LoggerAppender factory (string $name, string $class)
static LoggerAppender singleton (string $name, [string $class = ''])
void addFilter (LoggerFilter $newFilter)
void clearFilters ()
void close ()
void doAppend (LoggerLoggingEvent $event)
object Returns getErrorHandler ()
string getName ()
boolean requiresLayout ()
void setErrorHandler (object $errorHandler)
void setLayout (LoggerLayout $layout)
void setName (string $name)
Methods
static method factory (line 33)

Factory

  • access: public
static LoggerAppender factory (string $name, string $class)
  • string $name: appender name
  • string $class: create an instance of this appender class
static method singleton (line 53)

Singleton

  • access: public
static LoggerAppender singleton (string $name, [string $class = ''])
  • string $name: appender name
  • string $class: create or get a reference instance of this class
addFilter (line 83)

Add a filter to the end of the filter list.

  • abstract:
  • access: public
void addFilter (LoggerFilter $newFilter)

Redefined in descendants as:
clearFilters (line 89)

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

  • abstract:
void clearFilters ()

Redefined in descendants as:
doAppend (line 112)

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

  • abstract:
  • access: public
void doAppend (LoggerLoggingEvent $event)

Redefined in descendants as:
getErrorHandler (line 131)

Do not use this method.

  • return: the ErrorHandler for this appender.
  • abstract:
  • access: public
object Returns getErrorHandler ()

Redefined in descendants as:
getFilter (line 96)

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

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

  • abstract:
LoggerFilter getFilter ()

Redefined in descendants as:
getLayout (line 144)

Returns this appender layout.

  • abstract:
  • access: public
LoggerLayout getLayout ()

Redefined in descendants as:
getName (line 118)

Get the name of this appender.

  • abstract:
  • access: public
string getName ()

Redefined in descendants as:
requiresLayout (line 172)

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.

  • abstract:
  • access: public
boolean requiresLayout ()

Redefined in descendants as:
setErrorHandler (line 125)

Do not use this method.

  • abstract:
  • access: public
void setErrorHandler (object $errorHandler)
  • object $errorHandler

Redefined in descendants as:
setLayout (line 138)

Set the Layout for this appender.

  • abstract:
  • access: public
void setLayout (LoggerLayout $layout)

Redefined in descendants as:
setName (line 153)

Set the name of this appender.

The name is used by other components to identify this appender.

  • abstract:
  • access: public
void setName (string $name)
  • string $name

Redefined in descendants as:

Documentation generated by phpDocumentor 1.3.2