PHPXRef 0.7.1 : vtigercrm-6.1.0 : Detail view of LoggerHierarchy.php

[Source view] [Print] [Project Stats]

log4php is a PHP port of the log4j java logging package. This framework is based on log4j (see {@link http://jakarta.apache.org/log4j log4j} for details). Design, strategies and part of the methods documentation are developed by log4j team (Ceki G�lc� as log4j project founder and {@link http://jakarta.apache.org/log4j/docs/contributors.html contributors}).

File Size:	388 lines (12 kb)
Included or required:	1 time
Referenced:	0 times
Includes or requires:	5 files libraries/log4php.debug/LoggerLevel.php libraries/log4php.debug/LoggerLog.php libraries/log4php.debug/LoggerDefaultCategoryFactory.php libraries/log4php.debug/or/LoggerRendererMap.php libraries/log4php.debug/LoggerRoot.php

Defines 1 class

LoggerHierarchy:: (22 methods):
  singleton()
  LoggerHierarchy()
  addHierarchyEventListener()
  addRenderer()
  clear()
  emitNoAppenderWarning()
  exists()
  fireAddAppenderEvent()
  getCurrentCategories()
  getCurrentLoggers()
  getLogger()
  getLoggerByFactory()
  getRendererMap()
  getRootLogger()
  getThreshold()
  isDisabled()
  overrideAsNeeded()
  resetConfiguration()
  setDisableOverride()
  setRenderer()
  setThreshold()
  shutdown()

Class: LoggerHierarchy - X-Ref

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.

singleton() X-Ref

LoggerHierarchy($root) X-Ref

Create a new logger hierarchy.

param: object $root the root logger

addHierarchyEventListener($listener) X-Ref

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

addRenderer($classToRender, $or) X-Ref

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

clear() X-Ref

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

emitNoAppenderWarning($cat) X-Ref

No description

exists($name) X-Ref

Check if the named logger exists in the hierarchy.

param: string $name
return: boolean

fireAddAppenderEvent($logger, $appender) X-Ref

No description

getCurrentCategories() X-Ref

getCurrentLoggers() X-Ref

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

return: array

getLogger($name, $factory = null) X-Ref

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

param: string $name logger name
param: LoggerFactory $factory a {@link LoggerFactory} instance or null
return: Logger

getLoggerByFactory($name, $factory) X-Ref

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

param: string $name logger name
return: Logger

getRendererMap() X-Ref

return: LoggerRendererMap Get the renderer map for this hierarchy.

getRootLogger() X-Ref

return: LoggerRoot Get the root of this hierarchy.

getThreshold() X-Ref

return: LoggerLevel Returns the threshold Level.

isDisabled($level) X-Ref

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

return: boolean

overrideAsNeeded($override) X-Ref

resetConfiguration() X-Ref

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

This removes all appenders from all categories, sets
the level of all non-root categories to null,
sets their additivity flag to true and sets the level
of the root logger to {@link LOGGER_LEVEL_DEBUG}. Moreover,
message disabling is set its default "off" value.

Existing categories are not removed. They are just reset.

This method should be used sparingly and with care as it will
block all logging until it is completed.

setDisableOverride($override) X-Ref

setRenderer($renderedClass, $renderer) X-Ref

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

param: string $renderedClass a LoggerRenderer class name
param: LoggerRenderer $renderer

setThreshold($l) X-Ref

set a new threshold level

param: LoggerLevel $l

shutdown() X-Ref

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

Some appenders such as {@link LoggerSocketAppender}
need to be closed before the
application exists. Otherwise, pending logging events might be
lost.

The shutdown method is careful to close nested
appenders before closing regular appenders. This is allows
configurations where a regular appender is attached to a logger
and again to a nested appender.

PHP Cross Reference of vtigercrm-6.1.0

/libraries/log4php.debug/ -> LoggerHierarchy.php (summary)

Defines 1 class