Class LoggerXmlLayout

(line 31)
LoggerLayout
   |
   --LoggerXmlLayout

Located in File: Program_Root/layout/LoggerXmlLayout.php

The output of the XMLLayout consists of a series of log4php:event elements. It does not output a complete well-formed XML file.

The output is designed to be included as an external entity in a separate file to form a correct XML file.

Class Variable Summary
$locationInfo
Default Value: ->false<-
Inherited Class Variable Summary
Method Summary
void activateOptions ( )
No options to activate.
void format ( $event )
Formats a LoggerEvent in conformance with the log4j.dtd.
void getLocationInfo ( )
Returns the current value of the LocationInfo option.
void ignoresThrowable ( )
The XMLLayout prints and does not ignore exceptions.
void setLocationInfo ( $flag )
The LocationInfo option takes a boolean value.
Inherited Method Summary
Inherited From Class LoggerLayout
Function Description
LoggerLayout::activateOptions()
LoggerLayout::factory()
LoggerLayout::format() Override this method to create your own layout format.
LoggerLayout::getContentType() Returns the content type output by this layout.
LoggerLayout::getFooter() Returns the footer for the layout format.
LoggerLayout::getHeader() Returns the header for the layout format.
Method Detail

activateOptions

(line 56)

void activateOptions( )

Overrides LoggerLayout::activateOptions() (parent method not documented)

No options to activate.
Function Info:

[ Top ]

format

(line 62)

void format( mixed $event)

Overrides LoggerLayout::format() (Override this method to create your own layout format.)

Formats a LoggerEvent in conformance with the log4j.dtd.
Function Info:

[ Top ]

getLocationInfo

(line 49)

void getLocationInfo( )

Returns the current value of the LocationInfo option.
Function Info:

[ Top ]

ignoresThrowable

(line 81)

void ignoresThrowable( )

The XMLLayout prints and does not ignore exceptions.

Hence the return value 

false
.

Function Info:

[ Top ]

setLocationInfo

(line 42)

void setLocationInfo( mixed $flag)

The LocationInfo option takes a boolean value.

By default, it is set to false which means there will be no location information output by this layout. If the the option is set to true, then the file name and line number of the statement at the origin of the log statement will be output.

Function Info:

[ Top ]

Variable Detail

$locationInfo

(line 33)
Data type: mixed

[ Top ]

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