Class LoggerCategory

(line 25)

Classes extended from LoggerCategory:

Logger
Main class for logging operations

Located in File: Program_Root/LoggerCategory.php


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

Class Variable Summary
$aai
Default Value: ->array()<-
$additive
Default Value: ->true<-
$fqcn
Default Value: ->LoggerCategory<-
$level
Default Value: ->null<-
$name
Default Value: -><-
$parent
Default Value: ->null<-
$repository
Default Value: ->null<-

Inherited Class Variable Summary

Method Summary
void constructor LoggerCategory ( $name )
Constructor.
void addAppender ( &$newAppender )
Add newAppender to the list of appenders of this Category instance.
void assertLog ( [$assertion = true], [$msg = ''] )
If assertion parameter is false, then logs msg as an error statement.
void callAppenders ( $event )
Call the appenders in the hierrachy starting at this.
void debug ( $message, [$caller = null] )
Log a message object with the DEBUG level including the caller.
void error ( $message, [$caller = null] )
Log a message object with the LOGGER_LEVEL_ERROR level including the caller.
void exists ( $name )
Deprecated.
void fatal ( $message, [$caller = null] )
Log a message object with the LOGGER_LEVEL_FATAL level including the caller.
void forcedLog ( $caller, $level, $message )
This method creates a new logging event and logs the event without further checks.
void getAdditivity ( )
Get the additivity flag for this Category instance.
array getAllAppenders ( )
Get the appenders contained in this category as an Enumeration.
object &getAppender ( $name )
Look for the appender named as name.
void getChainedPriority ( )
Please use the the getEffectiveLevel() method instead.
void getCurrentCategories ( )
Please use LogManager::getCurrentLoggers() instead.
void getDefaultHierarchy ( )
Please use LogManager::getLoggerRepository() instead.
void getEffectiveLevel ( )
Starting from this category, search the category hierarchy for a non-null level and return it.
void &getHierarchy ( )
Please use getLoggerRepository() instead.
void &getInstance ( $name )
Retrieve a category with named as the name parameter.
void getLevel ( )
Returns the assigned Level, if any, for this Category.
void &getLoggerRepository ( )
Return the the LoggerRepository where this Category is attached.
void getName ( )
Return the category name.
void &getParent ( )
Returns the parent of this category.
void getPriority ( )
void getResourceBundle ( )
Return the inherited ResourceBundle for this category.
void getResourceBundleString ( $key )
Returns the string resource coresponding to key in this category's inherited resource bundle.
void &getRoot ( )
Return the root of the default category hierrachy.
void info ( $message, [$caller = null] )
Log a message object with the LOGGER_LEVEL_INFO Level.
void isAttached ( $appender )
Is the appender passed as parameter attached to this category?
void isDebugEnabled ( )
Check whether this category is enabled for the LOGGER_LEVEL_DEBUG Level.
void isEnabledFor ( $level )
Check whether this category is enabled for a given Level passed as parameter.
void isInfoEnabled ( )
Check whether this category is enabled for the info Level.
void l7dlog ( $priority, $key, $params, $t )
Log a localized and parameterized message.
void log ( $priority, $message, [$caller = null] )
This generic form is intended to be used by wrappers.
void removeAllAppenders ( )
Remove all previously added appenders from this Category instance.
void removeAppender ( $appender )
Remove the appender passed as parameter form the list of appenders.
void setAdditivity ( $additive )
Set the additivity flag for this Category instance.
void setLevel ( $level )
Set the level of this Category.
void setPriority ( $priority )
void setResourceBundle ( $bundle )
Set the resource bundle to be used with localized logging methods
void shutdown ( )
void warn ( $message, [$caller = null] )
Log a message with the LOGGER_LEVEL_WARN level.
Inherited Method Summary

Method Detail

Constructor LoggerCategory

(line 74)

void LoggerCategory( string $name)

Constructor.
Function Parameters:
- string $name: Category name
Function Info:

[ Top ]


addAppender

(line 86)

void addAppender( mixed &$newAppender, object $newAppender)

Add newAppender to the list of appenders of this Category instance.
Function Parameters:
- object $newAppender: Appender Object
Function Info:
see - LoggerAppender

[ Top ]


assertLog

(line 98)

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

If assertion parameter is false, then logs msg as an error statement.
Function Parameters:
- bool $assertion:
- string $msg: message to log
Function Info:

[ Top ]


callAppenders

(line 111)

void callAppenders( object $event)

Call the appenders in the hierrachy starting at this.
Function Parameters:
- object $event: LoggerEvent
Function Info:
see - LoggerEvent

[ Top ]


debug

(line 129)

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

Log a message object with the DEBUG level including the caller.
Function Parameters:
- string $message: message
- mixed $caller: caller object or caller string id
Function Info:

[ Top ]


error

(line 145)

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

Log a message object with the LOGGER_LEVEL_ERROR level including the caller.
Function Parameters:
- string $message: message
- mixed $caller: caller object or caller string id
Function Info:

[ Top ]


exists

(line 162)

void exists( string $name)

Deprecated.

Please use LoggerManager::exists() instead.

Function Parameters:
- string $name:
Function Info:
deprecated -
see - LoggerManager::exists()

[ Top ]


fatal

(line 173)

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

Log a message object with the LOGGER_LEVEL_FATAL level including the caller.
Function Parameters:
- string $message: message
- mixed $caller: caller object or caller string id
Function Info:

[ Top ]


forcedLog

(line 191)

void forcedLog( mixed $caller, integer $level, string $message)

This method creates a new logging event and logs the event without further checks.
Function Parameters:
- mixed $caller: caller object or caller string id
- integer $level: log level
- string $message: message
Function Info:
see - LoggerEvent

[ Top ]


getAdditivity

(line 200)

void getAdditivity( )

Get the additivity flag for this Category instance.
Function Info:

[ Top ]


getAllAppenders

(line 209)

array getAllAppenders( )

Get the appenders contained in this category as an Enumeration.
Function Info:
return - collection of appenders

[ Top ]


getAppender

(line 219)

object &getAppender( mixed $name)

Look for the appender named as name.
Function Info:
see - LoggerAppender

[ Top ]


getChainedPriority

(line 228)

void getChainedPriority( )

Please use the the getEffectiveLevel() method instead.
Function Info:
deprecated -

[ Top ]


getCurrentCategories

(line 237)

void getCurrentCategories( )

Please use LogManager::getCurrentLoggers() instead.
Function Info:
deprecated -

[ Top ]


getDefaultHierarchy

(line 246)

void getDefaultHierarchy( )

Please use LogManager::getLoggerRepository() instead.
Function Info:
deprecated -

[ Top ]


getEffectiveLevel

(line 254)

void getEffectiveLevel( )

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

[ Top ]


getHierarchy

(line 267)

void &getHierarchy( )

Please use getLoggerRepository() instead.
Function Info:
deprecated -

[ Top ]


getInstance

(line 275)

void &getInstance( mixed $name)

Retrieve a category with named as the name parameter.
Function Info:

[ Top ]


getLevel

(line 283)

void getLevel( )

Returns the assigned Level, if any, for this Category.
Function Info:

[ Top ]


getLoggerRepository

(line 291)

void &getLoggerRepository( )

Return the the LoggerRepository where this Category is attached.
Function Info:

[ Top ]


getName

(line 299)

void getName( )

Return the category name.
Function Info:

[ Top ]


getParent

(line 307)

void &getParent( )

Returns the parent of this category.
Function Info:

[ Top ]


getPriority

(line 315)

void getPriority( )


Function Info:
deprecated - Please use getLevel() instead.

[ Top ]


getResourceBundle

(line 323)

void getResourceBundle( )

Return the inherited ResourceBundle for this category.
Function Info:

[ Top ]


getResourceBundleString

(line 331)

void getResourceBundleString( mixed $key)

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

[ Top ]


getRoot

(line 339)

void &getRoot( )

Return the root of the default category hierrachy.
Function Info:

[ Top ]


info

(line 350)

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

Log a message object with the LOGGER_LEVEL_INFO Level.
Function Parameters:
- string $message: message
- mixed $caller: caller object or caller string id
Function Info:

[ Top ]


isAttached

(line 364)

void isAttached( object $appender)

Is the appender passed as parameter attached to this category?
Function Parameters:
- object $appender: appender to test
Function Info:

[ Top ]


isDebugEnabled

(line 372)

void isDebugEnabled( )

Check whether this category is enabled for the LOGGER_LEVEL_DEBUG Level.
Function Info:

[ Top ]


isEnabledFor

(line 386)

void isEnabledFor( integer $level)

Check whether this category is enabled for a given Level passed as parameter.
Function Parameters:
- integer $level: level
Function Info:
see - LoggerLevel

[ Top ]


isInfoEnabled

(line 397)

void isInfoEnabled( )

Check whether this category is enabled for the info Level.
Function Info:

[ Top ]


l7dlog

(line 408)

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

Log a localized and parameterized message.
Function Info:

[ Top ]


log

(line 420)

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

This generic form is intended to be used by wrappers.
Function Parameters:
- integer $priority: log with this level
- string $message: message
- mixed $caller: caller object or caller string id
Function Info:

[ Top ]


removeAllAppenders

(line 433)

void removeAllAppenders( )

Remove all previously added appenders from this Category instance.
Function Info:

[ Top ]


removeAppender

(line 443)

void removeAppender( mixed $appender)

Remove the appender passed as parameter form the list of appenders.
Function Parameters:
- mixed $appender: can be an appender name or a LoggerAppender object
Function Info:

[ Top ]


setAdditivity

(line 457)

void setAdditivity( boolean $additive)

Set the additivity flag for this Category instance.
Function Parameters:
- boolean $additive:
Function Info:

[ Top ]


setLevel

(line 476)

void setLevel( integer $level)

Set the level of this Category.
Function Parameters:
- integer $level:
Function Info:

[ Top ]


setPriority

(line 466)

void setPriority( mixed $priority)


Function Info:
see - LoggerCategory::setLevel()
deprecated - Please use setLevel($Level) instead.

[ Top ]


setResourceBundle

(line 485)

void setResourceBundle( mixed $bundle)

Set the resource bundle to be used with localized logging methods
Function Info:

[ Top ]


shutdown

(line 494)

void shutdown( )


Function Info:
see - LoggerManager::shutdown()
deprecated - use LoggerManager::shutdown() instead.

[ Top ]


warn

(line 505)

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

Log a message with the LOGGER_LEVEL_WARN level.
Function Parameters:
- string $message: message
- mixed $caller: caller object or caller string id
Function Info:

[ Top ]



Variable Detail

$aai

(line 63)
Data type: array

[ Top ]

$additive

(line 30)
Data type: boolean

[ Top ]

$fqcn

(line 35)
Data type: string

[ Top ]

$level

(line 40)
Data type: integer

[ Top ]

$name

(line 45)
Data type: string

[ Top ]

$parent

(line 51)
Data type: The

[ Top ]

$repository

(line 57)
Data type: the

[ Top ]



Documention generated on Thu, 20 Feb 2003 15:43:02 +0100 by phpDocumentor 1.2.0rc1