Docs For Class LoggerCategory

Class LoggerCategory

Description

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

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

Located in Program_Root/src/log4php/LoggerCategory.php (line 30)

Direct descendents

Class	Description
Logger	Main class for logging operations

Variable Summary

array $aai

boolean $additive

string $fqcn

integer $level

string $name

object The $parent

object the $repository

Method Summary

LoggerCategory LoggerCategory (string $name)

void addAppender (object &$newAppender)

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

void callAppenders (object $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 (mixed $caller, integer $level, mixed $message)

void getAdditivity ()

array getAllAppenders ()

object {@link &getAppender (mixed $name)

void getChainedPriority ()

void getCurrentCategories ()

void getDefaultHierarchy ()

void getEffectiveLevel ()

void &getHierarchy ()

void &getInstance (mixed $name)

void getLevel ()

void &getLoggerRepository ()

void getName ()

void &getParent ()

void getPriority ()

void getResourceBundle ()

void getResourceBundleString (mixed $key)

void &getRoot ()

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

void isAttached (object $appender)

void isDebugEnabled ()

void isEnabledFor (integer $level)

void isInfoEnabled ()

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

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

void removeAllAppenders ()

void removeAppender (mixed $appender)

void setAdditivity (boolean $additive)

void setLevel (integer $level)

void setPriority (mixed $priority)

void setResourceBundle (mixed $bundle)

void shutdown ()

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

Variables

array $aai = array() (line 68)

var: collection of appenders
see: LoggerAppender

boolean $additive = true (line 35)

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

string $fqcn = 'LoggerCategory' (line 40)

var: fully qualified class name

integer $level = null (line 45)

var: The assigned level of this category.

string $name = '' (line 50)

var: name of this category.

Redefined in descendants as:

LoggerRoot::$name

object The $parent = null (line 56)

var: parent of this category.
see: Logger

Redefined in descendants as:

LoggerRoot::$parent

object the $repository = null (line 62)

var: object repository
see: LoggerHierarchy

Methods

Constructor LoggerCategory (line 79)

Constructor.

LoggerCategory LoggerCategory (string $name)

string $name: Category name

addAppender (line 91)

Add newAppender to the list of appenders of this Category instance.

see: LoggerAppender

void addAppender (object &$newAppender)

object $newAppender: Appender Object

assertLog (line 103)

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 116)

Call the appenders in the hierrachy starting at this.

see: LoggerEvent

void callAppenders (object $event)

object $event: LoggerEvent

debug (line 134)

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

error (line 150)

Log a message object with the LOGGER_LEVEL_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 167)

Deprecated.

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

deprecated:
see: LoggerManager::exists()

void exists (string $name)

string $name

fatal (line 178)

Log a message object with the LOGGER_LEVEL_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 199)

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 (mixed $caller, integer $level, mixed $message)

mixed $caller: caller object or caller string id
integer $level: log level
mixed $message: message

getAdditivity (line 208)

Get the additivity flag for this Category instance.

void getAdditivity ()

getAllAppenders (line 217)

Get the appenders contained in this category as an Enumeration.

return: collection of appenders

array getAllAppenders ()

getAppender (line 226)

Look for the appender named as name.

return: LoggerAppender}

object {@link &getAppender (mixed $name)

getChainedPriority (line 235)

Please use the getEffectiveLevel() method instead.

deprecated:

void getChainedPriority ()

getCurrentCategories (line 244)

Please use LoggerManager::getCurrentLoggers() instead.

deprecated:

void getCurrentCategories ()

getDefaultHierarchy (line 253)

Please use LoggerManager::getLoggerRepository() instead.

deprecated:

void getDefaultHierarchy ()

getEffectiveLevel (line 261)

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

void getEffectiveLevel ()

getHierarchy (line 274)

Please use getLoggerRepository() instead.

deprecated:

void &getHierarchy ()

getInstance (line 282)

Retrieve a category with named as the name parameter.

void &getInstance (mixed $name)

getLevel (line 290)

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

void getLevel ()

getLoggerRepository (line 298)

Return the the LoggerRepository where this Category is attached.

void &getLoggerRepository ()

getName (line 306)

Return the category name.

void getName ()

getParent (line 314)

Returns the parent of this category.

void &getParent ()

getPriority (line 322)

deprecated: Please use getLevel() instead.

void getPriority ()

getResourceBundle (line 330)

Return the inherited ResourceBundle for this category.

void getResourceBundle ()

getResourceBundleString (line 338)

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

void getResourceBundleString (mixed $key)

getRoot (line 346)

Return the root of the default category hierrachy.

void &getRoot ()

info (line 357)

Log a message object with the LOGGER_LEVEL_INFO Level.

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

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

isAttached (line 372)

Is the appender passed as parameter attached to this category?

void isAttached (object $appender)

object $appender: LoggerAppender to test

isDebugEnabled (line 380)

Check whether this category is enabled for the LOGGER_LEVEL_DEBUG Level.

void isDebugEnabled ()

isEnabledFor (line 394)

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

see: LoggerLevel

void isEnabledFor (integer $level)

integer $level: level

isInfoEnabled (line 405)

Check whether this category is enabled for the info Level.

void isInfoEnabled ()

l7dlog (line 416)

Log a localized and parameterized message.

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

log (line 428)

This generic form is intended to be used by wrappers.

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

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

removeAllAppenders (line 441)

Remove all previously added appenders from this Category instance.

void removeAllAppenders ()

removeAppender (line 451)

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 465)

Set the additivity flag for this Category instance.

void setAdditivity (boolean $additive)

boolean $additive

setLevel (line 484)

Set the level of this Category.

void setLevel (integer $level)

integer $level

Redefined in descendants as:

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

setPriority (line 474)

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

void setPriority (mixed $priority)

Redefined in descendants as:

LoggerRoot::setPriority()

setResourceBundle (line 493)

Set the resource bundle to be used with localized logging methods

void setResourceBundle (mixed $bundle)

shutdown (line 502)

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

void shutdown ()

warn (line 513)

Log a message with the LOGGER_LEVEL_WARN level.

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

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

Documentation generated on Wed, 27 Aug 2003 18:11:37 +0200 by phpDocumentor 1.2.2