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.13 $
author: VxR <mailto:vxr@vxr.it>

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

LoggerLayout
   |
   --LoggerLayoutHtml

Variable Summary

boolean $locationInfo

string $title

Method Summary

LoggerLayoutHtml LoggerLayoutHtml ()

void activateOptions ()

string format (LoggerLoggingEvent $event)

string getContentType ()

string getFooter ()

string getHeader ()

void getLocationInfo ()

string getTitle ()

void setLocationInfo (mixed $flag)

void setTitle (mixed $title)

Variables

boolean $locationInfo = false (line 68)

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 76)

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 81)

Constructor

LoggerLayoutHtml LoggerLayoutHtml ()

activateOptions (line 143)

No options to activate.

void activateOptions ()

Redefinition of:

LoggerLayout::activateOptions(): Override this method

format (line 152)

string format (LoggerLoggingEvent $event)

LoggerLoggingEvent $event

Redefinition of:

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

getContentType (line 135)

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

string getContentType ()

Redefinition of:

LoggerLayout::getContentType(): Returns the content type output by this layout.

getFooter (line 247)

return: Returns the appropriate HTML footers.

string getFooter ()

Redefinition of:

LoggerLayout::getFooter(): Returns the footer for the layout format.

getHeader (line 213)

return: Returns appropriate HTML headers.

string getHeader ()

Redefinition of:

LoggerLayout::getHeader(): Returns the header for the layout format.

getLocationInfo (line 109)

Returns the current value of the LocationInfo option.

void getLocationInfo ()

getTitle (line 127)

return: Returns the current value of the Title option.

string getTitle ()

setLocationInfo (line 97)

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 119)

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