Docs For Class LoggerAppender

Class LoggerAppender

(line 22)

Classes extended from LoggerAppender:

LoggerAppenderSocket: Log event to a network socket

LoggerAppenderFile: FileAppender appends log events to a file.

LoggerAppenderConsole: ConsoleAppender appends log events to Stdout or Stderr using a layout specified by the user.

LoggerAppenderPhp: Log event using php trigger_error function

LoggerAppenderSyslog: Log event using php syslog() function

Located in File: Program_Root/LoggerAppender.php

Abstract class that defines output logs strategies.

version - $Revision: 1.4 $
author - Marco Vassura

Class Variable Summary

$closed

Default Value: -><-

$errorHandler

Default Value: -><-

$filters

Default Value: ->array()<-

$headFilter

Default Value: ->null<-

$layout

Default Value: ->null<-

$name

Default Value: -><-

$requiresLayout

Default Value: ->false<-

$tailFilter

Default Value: ->null<-

$threshold

Default Value: -><-

Inherited Class Variable Summary

Method Summary

void constructor LoggerAppender ( $name )

Constructor

void addFilter ( $newFilter )

Add a filter to the end of the filter list.

void clearFilters ( )

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

void close ( )

Release any resources allocated.

void doAppend ( $event )

Log in Appender specific way.

a factory ( $name, $class )

Factory

void getErrorHandler ( )

Returns the ErrorHandler for this appender.

void getFilter ( )

Returns the head Filter.

object getLayout ( )

Returns this appender layout.

string getName ( )

Get the name of this appender.

void requiresLayout ( )

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

void setErrorHandler ( $errorHandler )

Set the ErrorHandler for this appender.

void setLayout ( $layout )

Set the Layout for this appender.

void setName ( $name )

Set the name of this appender.

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

Singleton

Inherited Method Summary

Method Detail

Constructor LoggerAppender

(line 116)

void LoggerAppender( string $name)

Constructor

Function Parameters:: - string $name: appender name
Function Info:

[ Top ]

addFilter

(line 127)

void addFilter( object $newFilter)

Add a filter to the end of the filter list.

Function Parameters:: - object $newFilter: a LoggerFilter to add
Function Info:

[ Top ]

clearFilters

(line 138)

void clearFilters( )

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

Function Info:

[ Top ]

close

(line 146)

void close( )

Overridden in child classes as:

LoggerAppenderSocket::close()

LoggerAppenderFile::close()

LoggerAppenderConsole::close()

LoggerAppenderPhp::close()

LoggerAppenderSyslog::close()

Release any resources allocated.

Function Info:

[ Top ]

doAppend

(line 157)

void doAppend( object $event)

Overridden in child classes as:

LoggerAppenderSocket::doAppend(): Appends a LoggerEvent

LoggerAppenderFile::doAppend()

LoggerAppenderConsole::doAppend()

LoggerAppenderPhp::doAppend(): trig a LoggerEvent

LoggerAppenderSyslog::doAppend(): syslog a LoggerEvent

Log in Appender specific way.

Function Parameters:: - object $event: a LoggerEvent
Function Info:: see - LoggerEvent

[ Top ]

factory

(line 80)

a factory( string $name, string $class)

Factory

Function Parameters:: - string $name: appender name; - string $class: create an instance of this appender class
Function Info:: return - LoggerAppender

[ Top ]

getErrorHandler

(line 165)

void getErrorHandler( )

Returns the ErrorHandler for this appender.

Function Info:

[ Top ]

getFilter

(line 173)

void getFilter( )

Returns the head Filter.

Function Info:

[ Top ]

getLayout

(line 182)

object getLayout( )

Returns this appender layout.

Function Info:

[ Top ]

getName

(line 191)

string getName( )

Get the name of this appender.

Function Info:

[ Top ]

requiresLayout

(line 199)

void requiresLayout( )

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

Function Info:

[ Top ]

setErrorHandler

(line 207)

void setErrorHandler( mixed $errorHandler)

Set the ErrorHandler for this appender.

Function Info:

[ Top ]

setLayout

(line 217)

void setLayout( object $layout)

Set the Layout for this appender.

Function Parameters:: - object $layout: a LoggerLayout
Function Info:

[ Top ]

setName

(line 228)

void setName( string $name)

Set the name of this appender.

Function Parameters:: - string $name: appender name
Function Info:

[ Top ]

singleton

(line 94)

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

Singleton

Function Parameters:: - string $name: appender name; - string $class: create or get a reference instance of this class
Function Info:: return - a LoggerAppender or an array of LoggerAppender

[ Top ]

Variable Detail

$closed

(line 27)
Data type: boolean

var - closed appender flag

[ Top ]

$errorHandler

(line 32)
Data type: unused

[ Top ]

$filters

(line 67)
Data type: array

var - output filters (not yet impl.)

[ Top ]

$headFilter

(line 37)
Data type: The

var - first filter in the filter chain

[ Top ]

$layout

(line 42)
Data type: for

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

[ Top ]

$name

(line 47)
Data type: string

var - Appender name

[ Top ]

$requiresLayout

(line 62)
Data type: boolean

var - needs a layout formatting ?

[ Top ]

$tailFilter

(line 52)
Data type: The

var - last filter in the filter chain

[ Top ]

$threshold

(line 57)
Data type: integer

var - There is no level threshold filtering by default.

[ Top ]

Documention generated on Thu, 20 Feb 2003 15:42:59 +0100 by phpDocumentor 1.2.0rc1