Docs For Class Logger

Description

The Logger class is an abstract class that is intended to be used in libraries that do no want to impose a particular logging format and/or way of recording log messages.

The class also defines a couple of logs management functions to retrieve and suppress logs.

All methods must be implemented in concrete subclasses.

author: Sylvain Lequeux
author: Francois Daoust <fd@w3.org>
version: $Revision: 1.2 $
copyright: Copyright (c) 2009, W3C (MIT, ERCIM, Keio)
abstract:
license: W3C Software Notice and License

Located in /common/logger/interface/logger.php (line 32)

Direct descendents

Class	Description
FileLogger	The FileLogger class is a concrete implementation of the abstract Logger class that stores log messages in files.

Variable Summary

array(string) $levels

Method Summary

void add_message (string $message_content, [string $level = 'warning'])

void clear_messages ([string $level_value = 'all'])

array(Message) retrieve_messages ([string $level_value = 'all'])

Variables

array(string) $levels (line 36)

var: The set of levels to log (avoid 'all' value).
access: protected

Methods

add_message (line 44)

Logs a message at the given level.

abstract:
access: public

void add_message (string $message_content, [string $level = 'warning'])

string $message_content: The message to log.
string $level: Identifies the level

Redefined in descendants as:

FileLogger::add_message() : Adds a message to the set of message

clear_messages (line 63)

Purges the logs of all the messages that are at the requested leve.

abstract:
access: public

void clear_messages ([string $level_value = 'all'])

string $level_value: The level to purge. All the messages are suppressed when value is 'all'. Default value is 'all'.

Redefined in descendants as:

FileLogger::clear_messages() : Clears all messages to the set of messages which are in the given level.

retrieve_messages (line 54)

Retrieves all messages logged at the requested level.

return: A set of messages.
abstract:
access: public

array(Message) retrieve_messages ([string $level_value = 'all'])

string $level_value: The level you are interested in. All the messages should be returned when value is 'all'. Default value is 'all'.

Redefined in descendants as:

FileLogger::retrieve_messages() : Retirves all messages to the set of messages which are in the given level.