Docs For Class FileLogger

Description

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

Each message ends up in a file named after the level of the message.

3 levels of messages are maintained by default:

that logs the message

The class requires the existence of a "log" subfolder, and needs to have write-access to that subfolder.

Logger
   |
   --FileLogger

Method Summary

FileLogger __construct ()

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

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

a retrieve_messages ([$level_value $level_value = 'all'])

Variables

Inherited from Logger

Logger::$levels

Methods

Constructor __construct (line 50)

Builds the logger by setting the source folder and the supported levels.

FileLogger __construct ()

add_message (line 67)

Adds a message to the set of message

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

Redefinition of:

clear_messages (line 128)

Clears all messages to the set of messages which are in the given level.

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

$level_value $level_value: the level to search messages. If 'all', retrieve all the messages. By default, the value is 'all'.

Redefinition of:

Logger::clear_messages(): Purges the logs of all the messages that are at the requested leve.

retrieve_messages (line 88)

Retirves all messages to the set of messages which are in the given level.

a retrieve_messages ([$level_value $level_value = 'all'])

$level_value $level_value: the level to search messages. If 'all', retrieve all the messages. By default, the value is 'all'.

Redefinition of:

Logger::retrieve_messages(): Retrieves all messages logged at the requested level.

Inherited From Logger

Logger::add_message()
Logger::clear_messages()
Logger::retrieve_messages()