mojavi
[ class tree: mojavi ] [ index: mojavi ] [ all elements ]

Class: Logger

Source Location: /logging/Logger.class.php

Class Overview


Logger provides an interface for logging messages to multiple appenders.


Author(s):

  • Sean Kerr

Methods


Inherited Variables

Inherited Methods


Class Details

[line 81]
Logger provides an interface for logging messages to multiple appenders.



Tags:

since:  2.0
author:  Sean Kerr


[ Top ]


Class Methods


constructor Logger [line 119]

Logger &Logger( )

Create a new Logger instance.



Tags:

since:  2.0
access:  public


[ Top ]

method addAppender [line 144]

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:

since:  2.0
access:  public


Parameters:

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

[ Top ]

method cleanup [line 175]

void cleanup( )

Cleanup all appenders.



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




Tags:

since:  2.0
access:  public


[ Top ]

method getAppender [line 201]

Appender &getAppender( string $name)

Retrieve an appender.



Tags:

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


Parameters:

string   $name   An appender name.

[ Top ]

method getExitPriority [line 224]

int getExitPriority( )

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



Tags:

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


[ Top ]

method getPriority [line 240]

int getPriority( )

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



Tags:

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


[ Top ]

method log [line 255]

void log( Message &$message)

Log a message.



Tags:

since:  2.0
access:  public


Parameters:

Message   &$message   A Message instance.

[ Top ]

method removeAppender [line 300]

void removeAppender( string $name)

Remove an appender.



Tags:

since:  2.0
access:  public


Parameters:

string   $name   An appender name.

[ Top ]

method setExitPriority [line 330]

void setExitPriority( int $priority)

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



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




Tags:

since:  2.0
access:  public


Parameters:

int   $priority   A priority level.

[ Top ]

method setPriority [line 352]

void setPriority( int $priority)

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



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




Tags:

since:  2.0
access:  public


Parameters:

int   $priority   A priority level.

[ Top ]


Documentation generated on Wed, 15 Jun 2005 11:43:33 +0900 by phpDocumentor 1.2.3