Class LoggerLayoutHtml

Description

This layout outputs events in a HTML table.

Parameters are: $title, $locationInfo.

  • author: Marco Vassura
  • version: $Revision: 556784 $

Located in /layouts/LoggerLayoutHtml.php (line 47)

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 ( $flag)
void setTitle ( $title)
Variables
boolean $locationInfo = false (line 61)

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.

<p>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 69)

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

Constructor

LoggerLayoutHtml LoggerLayoutHtml ()
activateOptions (line 136)

No options to activate.

void activateOptions ()

Redefinition of:
LoggerLayout::activateOptions()
Override this method
format (line 145)
string format (LoggerLoggingEvent $event)

Redefinition of:
LoggerLayout::format()
Override this method to create your own layout format.
getContentType (line 128)
  • 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 240)
  • return: Returns the appropriate HTML footers.
string getFooter ()

Redefinition of:
LoggerLayout::getFooter()
Returns the footer for the layout format.
getHeader (line 206)
  • return: Returns appropriate HTML headers.
string getHeader ()

Redefinition of:
LoggerLayout::getHeader()
Returns the header for the layout format.
getLocationInfo (line 102)

Returns the current value of the LocationInfo option.

void getLocationInfo ()
getTitle (line 120)
  • return: Returns the current value of the Title option.
string getTitle ()
setLocationInfo (line 90)

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.

<p>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 ( $flag)
  • $flag
setTitle (line 112)

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 ( $title)
  • $title

Inherited Methods

Inherited From LoggerLayout

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

Documentation generated by phpDocumentor 1.3.2