Docs For Class LoggerLayoutTTCC

Description

TTCC layout format consists of time, thread, category and nested diagnostic context information, hence the name.

TTCC layout format consists of time, thread, category and nested diagnostic context information, hence the name. Each of the four fields can be individually enabled or disabled. The time format depends on the DateFormat used.

If no dateFormat is specified it defaults to '%c'. See php http://www.php.net/date function for details.

Params:

$threadPrinting (true|false) enable/disable pid reporting.
$categoryPrefixing (true|false) enable/disable logger category reporting.
$contextPrinting (true|false) enable/disable NDC reporting.
$microSecondsPrinting (true|false) enable/disable micro seconds reporting in timestamp.
$dateFormat (string) set date format. See php http://www.php.net/date function for details.

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

Located in Program_Root/log4php/layouts/LoggerLayoutTTCC.php (line 77)

LoggerLayout
   |
   --LoggerLayoutTTCC

Variable Summary

mixed $categoryPrefixing

mixed $contextPrinting

string $dateFormat

mixed $microSecondsPrinting

mixed $threadPrinting

Method Summary

LoggerLayoutTTCC LoggerLayoutTTCC ([string $dateFormat = ''])

string format (LoggerLoggingEvent $event)

boolean getCategoryPrefixing ()

boolean getContextPrinting ()

string getDateFormat ()

boolean getMicroSecondsPrinting ()

boolean getThreadPrinting ()

void ignoresThrowable ()

void setCategoryPrefixing (mixed $categoryPrefixing)

void setContextPrinting (mixed $contextPrinting)

void setDateFormat (mixed $dateFormat)

void setMicroSecondsPrinting (mixed $microSecondsPrinting)

void setThreadPrinting (mixed $threadPrinting)

Variables

mixed $categoryPrefixing = true (line 81)

mixed $contextPrinting = true (line 82)

string $dateFormat = '%c' (line 88)

var: date format. See http://www.php.net/strftime for details

mixed $microSecondsPrinting = true (line 83)

mixed $threadPrinting = true (line 80)

Methods

Constructor LoggerLayoutTTCC (line 96)

Constructor

see: LoggerLayoutTTCC::$dateFormat

LoggerLayoutTTCC LoggerLayoutTTCC ([string $dateFormat = ''])

string $dateFormat: date format

format (line 200)

In addition to the level of the statement and message, the returned string includes time, thread, category.

In addition to the level of the statement and message, the returned string includes time, thread, category. Time, thread, category are printed depending on options.

string format (LoggerLoggingEvent $event)

LoggerLoggingEvent $event

Redefinition of:

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

getCategoryPrefixing (line 136)

return: Returns value of the CategoryPrefixing option.

boolean getCategoryPrefixing ()

getContextPrinting (line 154)

return: Returns value of the ContextPrinting option.

boolean getContextPrinting ()

getDateFormat (line 187)

string getDateFormat ()

getMicroSecondsPrinting (line 173)

return: Returns value of the MicroSecondsPrinting option.

boolean getMicroSecondsPrinting ()

getThreadPrinting (line 118)

return: Returns value of the ThreadPrinting option.

boolean getThreadPrinting ()

ignoresThrowable (line 235)

void ignoresThrowable ()

setCategoryPrefixing (line 126)

The CategoryPrefixing option specifies whether Category name is part of log output or not.

The CategoryPrefixing option specifies whether Category name is part of log output or not. This is true by default.

void setCategoryPrefixing (mixed $categoryPrefixing)

setContextPrinting (line 145)

The ContextPrinting option specifies log output will include the nested context information belonging to the current thread.

The ContextPrinting option specifies log output will include the nested context information belonging to the current thread. This is true by default.

void setContextPrinting (mixed $contextPrinting)

setDateFormat (line 179)

void setDateFormat (mixed $dateFormat)

setMicroSecondsPrinting (line 164)

The MicroSecondsPrinting option specifies if microseconds infos should be printed at the end of timestamp.

The MicroSecondsPrinting option specifies if microseconds infos should be printed at the end of timestamp. This is true by default.

void setMicroSecondsPrinting (mixed $microSecondsPrinting)

setThreadPrinting (line 107)

The ThreadPrinting option specifies whether the name of the current thread is part of log output or not.

The ThreadPrinting option specifies whether the name of the current thread is part of log output or not. This is true by default.

void setThreadPrinting (mixed $threadPrinting)

Inherited Methods

Inherited From LoggerLayout

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