Docs For Class LoggerPatternConverter

Description

LoggerPatternConverter is an abstract class that provides the formatting functionality that derived classes need.

LoggerPatternConverter is an abstract class that provides the formatting functionality that derived classes need. Conversion specifiers in a conversion patterns are parsed to individual PatternConverters. Each of which is responsible for converting a logging event in a converter specific manner.

since: 0.3
abstract:
version: $Revision: 1.13 $
author: VxR <mailto:vxr@vxr.it>

Located in Program_Root/log4php/helpers/LoggerPatternConverter.php (line 52)

Direct descendents

Class	Description
LoggerBasicPatternConverter
LoggerLiteralPatternConverter
LoggerDatePatternConverter
LoggerMDCPatternConverter
LoggerLocationPatternConverter
LoggerNamedPatternConverter

Variable Summary

mixed $leftAlign

mixed $max

mixed $min

LoggerPatternConverter $next

Method Summary

LoggerPatternConverter LoggerPatternConverter ([LoggerFormattingInfo $fi = null])

void convert (LoggerLoggingEvent $event)

void format (string &$sbuf, LoggerLoggingEvent $e)

void spacePad (string &$sbuf, integer $length)

Variables

mixed $leftAlign = false (line 61)

mixed $max = 0x7FFFFFFF (line 60)

mixed $min = -1 (line 59)

LoggerPatternConverter $next = null (line 57)

var: next converter in converter chain

Methods

Constructor LoggerPatternConverter (line 68)

Constructor

LoggerPatternConverter LoggerPatternConverter ([LoggerFormattingInfo $fi = null])

LoggerFormattingInfo $fi

convert (line 83)

Derived pattern converters must override this method in order to convert conversion specifiers in the correct way.

void convert (LoggerLoggingEvent $event)

LoggerLoggingEvent $event

Redefined in descendants as:

format (line 91)

A template method for formatting in a converter specific way.

void format (string &$sbuf, LoggerLoggingEvent $e)

string &$sbuf: string buffer
LoggerLoggingEvent $e

Redefined in descendants as:

LoggerLiteralPatternConverter::format()

spacePad (line 132)

Fast space padding method.

todo: reimplement using PHP string functions

void spacePad (string &$sbuf, integer $length)

string &$sbuf: string buffer
integer $length: pad length