Docs For Class LoggerHierarchy

Description

This class is specialized in retrieving loggers by name and also maintaining the logger hierarchy.

This class is specialized in retrieving loggers by name and also maintaining the logger hierarchy. The casual user does not have to deal with this class directly.

The structure of the logger hierarchy is maintained by the getLogger method. The hierarchy is such that children link to their parent but parents do not have any pointers to their children. Moreover, loggers can be instantiated in any order, in particular descendant before ancestor.

In case a descendant is created before a particular ancestor, then it creates a provision node for the ancestor and adds itself to the provision node. Other descendants of the same ancestor add themselves to the previously created provision node.

todo: Implements a LoggerFactory to create Loggers
version: $Revision: 1.13 $
author: VxR <mailto:vxr@vxr.it>

Located in Program_Root/src/log4php/LoggerHierarchy.php (line 50)

Variable Summary

boolean $debug

object currently $defaultFactory

boolean $emittedNoAppenderWarning

boolean $emittedNoResourceBundleWarning

array $ht

object a $parser

object a $rendererMap

object a $root

integer $threshold

Method Summary

LoggerHierarchy LoggerHierarchy (object $root)

void addHierarchyEventListener (mixed $listener)

void addRenderer (mixed $classToRender, mixed $or)

void clear ()

void emitNoAppenderWarning (mixed $cat)

void exists (mixed $name)

void fireAddAppenderEvent (mixed $logger, mixed $appender)

void getCurrentCategories ()

void getCurrentLoggers ()

object {@link &getLogger (string $name)

void &getParser ()

void &getRendererMap ()

void &getRootLogger ()

void getThreshold ()

void isDisabled (mixed $level)

void overrideAsNeeded (mixed $override)

void resetConfiguration ()

void setDisableOverride (mixed $override)

void setRenderer (mixed $renderedClass, mixed $renderer)

void setThreshold (mixed $l, integer $i)

void shutdown ()

Variables

boolean $debug = false (line 61)

var: activate internal logging
see: LoggerLog

object currently $defaultFactory (line 55)

var: unused

boolean $emittedNoAppenderWarning = false (line 87)

var: currently unused

boolean $emittedNoResourceBundleWarning = false (line 92)

var: currently unused

array $ht = array() (line 66)

var: hierarchy tree. saves here all loggers

object a $parser = null (line 97)

var: LoggerConfigXmlParser instance

object a $rendererMap (line 76)

var: LoggerRendererMap instance

object a $root = null (line 71)

var: LoggerRoot instance

integer $threshold = LOGGER_LEVEL_ALL (line 82)

var: main level threshold
see: LoggerConfigXmlParser::xmltag_config()

Methods

Constructor LoggerHierarchy (line 107)

Create a new logger hierarchy.

LoggerHierarchy LoggerHierarchy (object $root)

object $root: the root logger

addHierarchyEventListener (line 120)

Add a HierarchyEventListener event to the repository.

Add a HierarchyEventListener event to the repository. Not Yet Impl.

void addHierarchyEventListener (mixed $listener)

addRenderer (line 129)

Add an object renderer for a specific class.

Add an object renderer for a specific class. Not Yet Impl.

void addRenderer (mixed $classToRender, mixed $or)

clear (line 137)

This call will clear all logger definitions from the internal hashtable.

void clear ()

emitNoAppenderWarning (line 143)

void emitNoAppenderWarning (mixed $cat)

exists (line 151)

Check if the named logger exists in the hierarchy.

void exists (mixed $name)

fireAddAppenderEvent (line 156)

void fireAddAppenderEvent (mixed $logger, mixed $appender)

getCurrentCategories (line 164)

deprecated: Please use getCurrentLoggers() instead.

void getCurrentCategories ()

getCurrentLoggers (line 172)

Returns all the currently defined categories in this hierarchy as an Enumeration.

void getCurrentLoggers ()

getLogger (line 183)

Return a new logger instance named as the first parameter using the default factory.

return: Logger} instance

object {@link &getLogger (string $name)

string $name: logger name

getParser (line 221)

void &getParser ()

getRendererMap (line 231)

Get the renderer map for this hierarchy.

void &getRendererMap ()

getRootLogger (line 239)

Get the root of this hierarchy.

void &getRootLogger ()

getThreshold (line 249)

Returns a Level representation of the enable state.

void getThreshold ()

isDisabled (line 257)

This method will return true if this repository is disabled for level object passed as parameter and false otherwise.

void isDisabled (mixed $level)

overrideAsNeeded (line 265)

deprecated: Deprecated with no replacement.

void overrideAsNeeded (mixed $override)

resetConfiguration (line 273)

Reset all values contained in this hierarchy instance to their default.

void resetConfiguration ()

setDisableOverride (line 285)

deprecated: Deprecated with no replacement.

void setDisableOverride (mixed $override)

setRenderer (line 293)

Used by subclasses to add a renderer to the hierarchy passed as parameter.

void setRenderer (mixed $renderedClass, mixed $renderer)

setThreshold (line 303)

set a new threshold level

void setThreshold (mixed $l, integer $i)

integer $i

shutdown (line 311)

Shutting down a hierarchy will safely close and remove all appenders in all categories including the root logger

void shutdown ()