common.logger
[ class tree: common.logger ] [ index: common.logger ] [ all elements ]

Class: Logger

Source Location: /logger/Logger.class.php

Class Overview


Logger provides an interface for logging exceptions to multiple appenders.


Author(s):

  • Simon Schmid (original by Sean Kerr)

Constants

Methods



Class Details

[line 18]
Logger provides an interface for logging exceptions to multiple appenders.



Tags:

since:  2.0 $Id$
author:  Simon Schmid (original by Sean Kerr)


[ Top ]


Class Methods


constructor __construct [line 125]

Logger __construct( )

Create a new Logger instance.



Tags:

access:  public
since:  2.0


[ Top ]

destructor __destruct [line 315]

void __destruct( )

Cleanup all appenders.



<note> This should never be called manually. </note>




Tags:

access:  public
since:  2.0


[ Top ]

method addAppender [line 153]

void addAppender( string $name, Appender $appender)

Add an appender.



<note> If an appender with the given name already exists, an error will be reported. </note>




Tags:

access:  public
since:  2.0


Parameters:

string   $name   An appender name.
Appender   $appender   An Appender instance.

[ Top ]

method getAppender [line 181]

Appender &getAppender( string $name)

Retrieve an appender.



Tags:

return:  An Appender instance, if the given appender exists, otherwise NULL.
access:  public
since:  2.0


Parameters:

string   $name   An appender name.

[ Top ]

method getExitPriority [line 252]

int getExitPriority( )

Retrieve the priority level that must be met or exceeded in order for Mojavi to exit upon the logging of an exception.



Tags:

return:  A priority level.
access:  public
since:  2.0


[ Top ]

method getPriority [line 294]

int getPriority( )

Retrieve the priority level that must be met or exceeded in order for this logger to log an exception.



Tags:

return:  A priority level.
access:  public
since:  2.0


[ Top ]

method log [line 339]

void log( Exception $e)

Log an exception.



Tags:

access:  public
since:  2.0


Parameters:

Exception   $e   An Exception instance.

[ Top ]

method removeAppender [line 205]

void removeAppender( string $name)

Remove an appender.



Tags:

access:  public
since:  2.0


Parameters:

string   $name   An appender name.

[ Top ]

method setExitPriority [line 234]

void setExitPriority( int $priority)

Set the priority level that must be met or exceeded in order for Mojavi to exit upon the logging of an exception.



<note> A priority level of 0 will turn of exiting. </note>




Tags:

access:  public
since:  2.0


Parameters:

int   $priority   A priority level.

[ Top ]

method setPriority [line 276]

void setPriority( int $priority)

Set the priority level that must be met or exceeded in order for this logger to log an exception.



<note> A priority level of 0 will log any exception. </note>




Tags:

access:  public
since:  2.0


Parameters:

int   $priority   A priority level.

[ Top ]


Class Constants

LEVEL_DEBUG =  1000

[line 32]

Debugging priority level.



This is defined as 1000.




Tags:

since:  2.0

[ Top ]

LEVEL_ERROR =  4000

[line 71]

Error priority level.



This is defined as 4000.




Tags:

since:  2.0

[ Top ]

LEVEL_FATAL =  5000

[line 84]

Fatal priority level.



This is defined as 5000.




Tags:

since:  2.0

[ Top ]

LEVEL_INFO =  2000

[line 45]

Info priority level.



This is defined as 2000.




Tags:

since:  2.0

[ Top ]

LEVEL_WARN =  3000

[line 58]

Warning priority level.



This is defined as 3000.




Tags:

since:  2.0

[ Top ]



Documentation generated on Tue, 21 Feb 2006 02:29:52 +0900 by phpDocumentor 1.3.0RC5