Docs For Class LoggerCategory

Class LoggerCategory

Description

This class has been deprecated and replaced by the Logger subclass.

see: Logger
version: $Revision: 1.17 $
author: VxR <mailto:vxr@vxr.it>

Located in Program_Root/log4php/LoggerCategory.php (line 37)

Direct descendents

Class	Description
Logger	Main class for logging operations

Variable Summary

array $aai

boolean $additive

string $fqcn

LoggerLevel $level

string $name

Logger $parent

LoggerHierarchy $repository

Method Summary

LoggerCategory LoggerCategory (string $name)

void addAppender (LoggerAppender &$newAppender)

void assertLog ([bool $assertion = true], [string $msg = ''])

void callAppenders (LoggerLoggingEvent $event)

void debug (mixed $message, [mixed $caller = null])

void error (mixed $message, [mixed $caller = null])

void exists (string $name)

void fatal (mixed $message, [mixed $caller = null])

void forcedLog (string $fqcn, mixed $caller, LoggerLevel $level, mixed $message)

boolean getAdditivity ()

array &getAllAppenders ()

LoggerAppender &getAppender (mixed $name)

void getChainedPriority ()

void getCurrentCategories ()

void &getDefaultHierarchy ()

LoggerLevel getEffectiveLevel ()

LoggerHierarchy &getHierarchy ()

Logger &getInstance (mixed $name)

LoggerLevel getLevel ()

LoggerHierarchy &getLoggerRepository ()

string getName ()

Logger &getParent ()

void getPriority ()

void getResourceBundle ()

void getResourceBundleString (mixed $key)

LoggerRoot &getRoot ()

void info (mixed $message, [mixed $caller = null])

void isAttached (LoggerAppender $appender)

boolean isDebugEnabled ()

boolean isEnabledFor (LoggerLevel $level)

boolean isInfoEnabled ()

void l7dlog (mixed $priority, mixed $key, mixed $params, mixed $t)

void log (LoggerLevel $priority, mixed $message, [mixed $caller = null])

void removeAllAppenders ()

void removeAppender (mixed $appender)

void setAdditivity (boolean $additive)

void setHierarchy (LoggerHierarchy &$repository)

void setLevel (LoggerLevel $level)

void setPriority (mixed $priority)

void setResourceBundle (mixed $bundle)

void shutdown ()

void warn (mixed $message, [mixed $caller = null])

Variables

array $aai = array() (line 75)

var: collection of appenders
see: LoggerAppender

boolean $additive = true (line 44)

Additivity is set to true by default, that is children inherit the appenders of their ancestors by default.

string $fqcn = 'LoggerCategory' (line 49)

var: fully qualified class name

Redefined in descendants as:

MyLogger::$fqcn

LoggerLevel $level = null (line 54)

var: The assigned level of this category.

string $name = '' (line 59)

var: name of this category.

Redefined in descendants as:

LoggerRoot::$name

Logger $parent = null (line 64)

var: The parent of this category.

Redefined in descendants as:

LoggerRoot::$parent

LoggerHierarchy $repository = null (line 69)

var: the object repository

Methods

Constructor LoggerCategory (line 86)

Constructor.

LoggerCategory LoggerCategory (string $name)

string $name: Category name

addAppender (line 96)

Add a new Appender to the list of appenders of this Category instance.

void addAppender (LoggerAppender &$newAppender)

LoggerAppender $newAppender

assertLog (line 108)

If assertion parameter is false, then logs msg as an error statement.

void assertLog ([bool $assertion = true], [string $msg = ''])

bool $assertion
string $msg: message to log

callAppenders (line 120)

Call the appenders in the hierarchy starting at this.

void callAppenders (LoggerLoggingEvent $event)

LoggerLoggingEvent $event

debug (line 138)

Log a message object with the DEBUG level including the caller.

void debug (mixed $message, [mixed $caller = null])

mixed $message: message
mixed $caller: caller object or caller string id

Redefined in descendants as:

MyLogger::debug() : Overrides the standard debug method by appending " world" at the end of each message.

error (line 155)

Log a message object with the ERROR level including the caller.

void error (mixed $message, [mixed $caller = null])

mixed $message: message
mixed $caller: caller object or caller string id

exists (line 173)

Deprecated.

Deprecated. Please use LoggerManager::exists() instead.

deprecated:
see: LoggerManager::exists()

void exists (string $name)

string $name

fatal (line 184)

Log a message object with the FATAL level including the caller.

void fatal (mixed $message, [mixed $caller = null])

mixed $message: message
mixed $caller: caller object or caller string id

forcedLog (line 207)

This method creates a new logging event and logs the event without further checks.

This method creates a new logging event and logs the event without further checks. It should not be called directly. Use info(), debug(), warn(), error() and fatal() wrappers.

see: LoggerLoggingEvent

void forcedLog (string $fqcn, mixed $caller, LoggerLevel $level, mixed $message)

string $fqcn: Fully Qualified Class Name of the Logger
mixed $caller: caller object or caller string id
LoggerLevel $level: log level
mixed $message: message

getAdditivity (line 217)

Get the additivity flag for this Category instance.

boolean getAdditivity ()

getAllAppenders (line 226)

Get the appenders contained in this category as an array.

return: collection of appenders

array &getAllAppenders ()

getAppender (line 242)

Look for the appender named as name.

LoggerAppender &getAppender (mixed $name)

getChainedPriority (line 251)

Please use the getEffectiveLevel() method instead.

deprecated:

void getChainedPriority ()

getCurrentCategories (line 260)

Please use LoggerManager::getCurrentLoggers() instead.

deprecated:

void getCurrentCategories ()

getDefaultHierarchy (line 269)

Please use LoggerManager::getLoggerRepository() instead.

deprecated:

void &getDefaultHierarchy ()

getEffectiveLevel (line 288)

Starting from this category, search the category hierarchy for a non-null level and return it.

return: or null
see: LoggerLevel

LoggerLevel getEffectiveLevel ()

getHierarchy (line 278)

deprecated: Use getLoggerRepository()

LoggerHierarchy &getHierarchy ()

getInstance (line 301)

Retrieve a category with named as the name parameter.

Logger &getInstance (mixed $name)

Redefined in descendants as:

MyLogger::getInstance() : This method overrides getInstance by supplying its own factory type as a parameter.

getLevel (line 310)

Returns the assigned Level, if any, for this Category.

return: or null

LoggerLevel getLevel ()

getLoggerRepository (line 319)

Return the the repository where this Category is attached.

LoggerHierarchy &getLoggerRepository ()

getName (line 328)

Return the category name.

string getName ()

getParent (line 337)

Returns the parent of this category.

Logger &getParent ()

getPriority (line 346)

Please use getLevel() instead.

deprecated:

void getPriority ()

getResourceBundle (line 354)

Return the inherited ResourceBundle for this category.

void getResourceBundle ()

getResourceBundleString (line 362)

Returns the string resource coresponding to key in this category's inherited resource bundle.

void getResourceBundleString (mixed $key)

getRoot (line 371)

Return the root of the default category hierrachy.

LoggerRoot &getRoot ()

info (line 382)

Log a message object with the INFO Level.

void info (mixed $message, [mixed $caller = null])

mixed $message: message
mixed $caller: caller object or caller string id

isAttached (line 398)

Is the appender passed as parameter attached to this category?

void isAttached (LoggerAppender $appender)

LoggerAppender $appender

isDebugEnabled (line 407)

Check whether this category is enabled for the DEBUG Level.

boolean isDebugEnabled ()

isEnabledFor (line 422)

Check whether this category is enabled for a given Level passed as parameter.

boolean isEnabledFor (LoggerLevel $level)

LoggerLevel $level: level

isInfoEnabled (line 435)

Check whether this category is enabled for the info Level.

see: LoggerLevel

boolean isInfoEnabled ()

l7dlog (line 447)

Log a localized and parameterized message.

void l7dlog (mixed $priority, mixed $key, mixed $params, mixed $t)

log (line 459)

This generic form is intended to be used by wrappers.

void log (LoggerLevel $priority, mixed $message, [mixed $caller = null])

LoggerLevel $priority: a valid level
mixed $message: message
mixed $caller: caller object or caller string id

removeAllAppenders (line 472)

Remove all previously added appenders from this Category instance.

void removeAllAppenders ()

removeAppender (line 486)

Remove the appender passed as parameter form the list of appenders.

void removeAppender (mixed $appender)

mixed $appender: can be an appender name or a LoggerAppender object

setAdditivity (line 502)

Set the additivity flag for this Category instance.

void setAdditivity (boolean $additive)

boolean $additive

setHierarchy (line 522)

Only the Hiearchy class can set the hiearchy of a category.

void setHierarchy (LoggerHierarchy &$repository)

LoggerHierarchy &$repository

setLevel (line 532)

Set the level of this Category.

void setLevel (LoggerLevel $level)

LoggerLevel $level: a level string or a level costant

Redefined in descendants as:

LoggerRoot::setLevel() : Setting a null value to the level of the root category may have catastrophic results.

setPriority (line 511)

see: LoggerCategory::setLevel()
deprecated: Please use setLevel() instead.

void setPriority (mixed $priority)

Redefined in descendants as:

LoggerRoot::setPriority() : Please use setLevel() instead.

setResourceBundle (line 540)

Set the resource bundle to be used with localized logging methods

void setResourceBundle (mixed $bundle)

shutdown (line 549)

see: LoggerManager::shutdown()
deprecated: use LoggerManager::shutdown() instead.

void shutdown ()

warn (line 560)

Log a message with the WARN level.

void warn (mixed $message, [mixed $caller = null])

mixed $message: message
mixed $caller: caller object or caller string id

Documentation generated on Mon, 1 Dec 2003 22:09:47 +0100 by phpDocumentor 1.2.2