Docs For Class LoggerLayoutHtml

Description

This layout outputs events in a HTML table.

This layout outputs events in a HTML table. Parameters are: $title, $locationInfo.

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

Located in Program_Root/src/log4php/layouts/LoggerLayoutHtml.php (line 44)

LoggerLayout
   |
   --LoggerLayoutHtml

Variable Summary

boolean $locationInfo

string $title

Method Summary

LoggerLayoutHtml LoggerLayoutHtml ()

void activateOptions ()

void format (mixed $event)

void getContentType ()

void getFooter ()

void getHeader ()

void getLocationInfo ()

void getTitle ()

void setLocationInfo (mixed $flag)

void setTitle (mixed $title)

Variables

boolean $locationInfo = false (line 58)

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

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. If you are embedding this layout within a LoggerAppenderMail or a LoggerAppenderMailEvent then make sure to set the LocationInfo option of that appender as well.

string $title = "Log4php Log Messages" (line 66)

The Title option takes a String value. document title of the generated HTML document.

The Title option takes a String value. This option sets the document title of the generated HTML document. Defaults to 'Log4php Log Messages'.

Methods

Constructor LoggerLayoutHtml (line 68)

LoggerLayoutHtml LoggerLayoutHtml ()

activateOptions (line 130)

No options to activate.

void activateOptions ()

Redefinition of:

LoggerLayout::activateOptions(): Override this method

format (line 135)

void format (mixed $event)

Redefinition of:

LoggerLayout::format()

getContentType (line 122)

Returns the content type output by this layout, i.

Returns the content type output by this layout, i.e "text/html".

void getContentType ()

Redefinition of:

LoggerLayout::getContentType()

getFooter (line 228)

Returns the appropriate HTML footers.

void getFooter ()

Redefinition of:

LoggerLayout::getFooter()

getHeader (line 194)

Returns appropriate HTML headers.

void getHeader ()

Redefinition of:

LoggerLayout::getHeader()

getLocationInfo (line 96)

Returns the current value of the LocationInfo option.

void getLocationInfo ()

getTitle (line 114)

Returns the current value of the Title option.

void getTitle ()

setLocationInfo (line 84)

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

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. If you are embedding this layout within a LoggerAppenderMail or a LoggerAppenderMailEvent then make sure to set the LocationInfo option of that appender as well.

void setLocationInfo (mixed $flag)

setTitle (line 106)

The Title option takes a String value. document title of the generated HTML document.

The Title option takes a String value. This option sets the document title of the generated HTML document. Defaults to 'Log4php Log Messages'.

void setTitle (mixed $title)

Inherited Methods

Inherited From LoggerLayout

LoggerLayout::activateOptions()
LoggerLayout::factory()
LoggerLayout::format()
LoggerLayout::getContentType()
LoggerLayout::getFooter()
LoggerLayout::getHeader()