## Class LoggerLayout

Description

Extend this abstract class to create your own log layout format.

- version: $Revision: 1213283 $
- abstract:

Located in /log4php/LoggerLayout.php (line 27)

    LoggerConfigurable
       |
       --LoggerLayout

Direct descendents

Class | Description
--- | ---
LoggerLayoutSerialized | Layout which formats the events using PHP's serialize() function.
LoggerLayoutPattern | A flexible layout configurable with a pattern string.
LoggerLayoutTTCC | TTCC layout format consists of time, thread, category and nested diagnostic context information, hence the name.
LoggerLayoutXml | The output of the LoggerXmlLayout consists of a series of log4php:event elements.
LoggerLayoutHtml | This layout outputs events in a HTML table.
LoggerLayoutSimple | A simple layout.

Method Summary
void activateOptions ()
string format (LoggerLoggingEvent $event)
string getContentType ()
string getFooter ()
string getHeader ()
void warn ( $message)
Methods
activateOptions (line 32)

Activates options for this layout.

Override this method if you have options to be activated.

- access: public

void activateOptions ()

Redefined in descendants as:

- LoggerLayoutPattern::activateOptions() : Processes the conversion pattern and creates a corresponding chain of pattern converters which will be used to format logging events.
- LoggerLayoutXml::activateOptions()

format (line 42)

Override this method to create your own layout format.

- access: public

string format (LoggerLoggingEvent $event)

- LoggerLoggingEvent $event

Redefined in descendants as:

- LoggerLayoutSerialized::format()
- LoggerLayoutPattern::format() : Produces a formatted string as specified by the conversion pattern.
- LoggerLayoutTTCC::format() : In addition to the level of the statement and message, the returned string includes time, thread, category.
- LoggerLayoutXml::format() : Formats a LoggerLoggingEvent in conformance with the log4php.dtd.
- LoggerLayoutHtml::format()
- LoggerLayoutSimple::format() : Returns the log statement in a format consisting of the

getContentType (line 50)

Returns the content type output by this layout.

- access: public

string getContentType ()

Redefined in descendants as:

- LoggerLayoutHtml::getContentType()

getFooter (line 58)

Returns the footer for the layout format.

- access: public

string getFooter ()

Redefined in descendants as:

- LoggerLayoutXml::getFooter()
- LoggerLayoutHtml::getFooter()

getHeader (line 66)

Returns the header for the layout format.

- access: public

string getHeader ()

Redefined in descendants as:

- LoggerLayoutXml::getHeader()
- LoggerLayoutHtml::getHeader()

warn (line 71)

Triggers a warning for this layout with the given message.

- access: protected

void warn ( $message)

- $message

Redefinition of:

LoggerConfigurable::warn()
  Triggers a warning.

#### Inherited Methods

Inherited From LoggerConfigurable

> LoggerConfigurable::setBoolean()
> LoggerConfigurable::setFileSize()
> LoggerConfigurable::setInteger()
> LoggerConfigurable::setLevel()
> LoggerConfigurable::setNumeric()
> LoggerConfigurable::setPositiveInteger()
> LoggerConfigurable::setString()
> LoggerConfigurable::warn()

Documentation generated on Mon, 02 Feb 2026 13:59:50 +0900 by phpDocumentor 1.4.4