AnewtLogHandlerBase Class Reference

Base class for log handlers. More...

List of all members.

Public Member Functions

 log ($domain, $level, $message)
 Log a message.

Public Attributes

 $level = ANEWT_LOG_LEVEL_MESSAGE
 The minimum log level to log for.

Protected Member Functions

 format_log_message ($domain=null, $level, $message)
 Format a log message.


Detailed Description

Base class for log handlers.

This class should be subclassed to be useful. Sample implementations are included.

See also:
AnewtLogHandlerDefault

AnewtLogHandlerFile

AnewtLogHandlerAbort

Definition at line 19 of file loghandlers.lib.php.


Member Function Documentation

AnewtLogHandlerBase::log ( domain,
level,
message 
) [abstract]

Log a message.

Parameters:
$domain The log domain. This can be null.
$level The log level.
$message The string to log.
See also:
AnewtLog

Reimplemented in AnewtLogHandlerDefault, AnewtLogHandlerFile, and AnewtLogHandlerAbort.

AnewtLogHandlerBase::format_log_message ( domain = null,
level,
message 
) [protected]

Format a log message.

This method should be used in AnewtLogHandlerBase subclasses to format the log messages.

Parameters:
$domain The log domain. This can be null.
$level The log level.
$message The string to log.
Returns:
Formatted log string.

Definition at line 64 of file loghandlers.lib.php.


Member Data Documentation

AnewtLogHandlerBase::$level = ANEWT_LOG_LEVEL_MESSAGE

The minimum log level to log for.

Though this field is marked as public, you should never change it. The AnewtLog class will take care of the log level when calling AnewtLog::add_handler.

See also:
AnewtLog::add_handler

Definition at line 28 of file loghandlers.lib.php.


The documentation for this class was generated from the following file:

Generated on Sun Aug 2 22:54:38 2009 for Anewt by  doxygen 1.5.9