Class LogMessage

Message
   |
   +----LogMessage

Located in File: Program_Root/log.mes.php


Class LogMessage
 This message-module creates an interface for the creation and displaying
 of log-messages.

 

Class Variable Summary
$name
name: Name of this module
Default Value: ->"LogMessage"<-
$id
id: Id of this module
Default Value: ->MES_LOG<-
$level
level: default level to show
Default Value: ->1<-
$log_file
log_file: file to store log information
Default Value: -><-

Method Summary
LogMessage ( [$enable = false], [$noop = false] )
Constructor LogMessage
set_level ( $level )
Function set_level
set_log_file ( $file )
Function set_log_file
addmessage ( $level )
Function addmessage
wrapped_up ( )
Function wrapped_up

Variable Detail

$name

name: Name of this module
 

$id

id: Id of this module
 

$level

level: default level to show
 

$log_file

log_file: file to store log information
 


Function Detail

LogMessage

LogMessage ( [$enable = false], [$noop = false] )

Constructor LogMessage
 Sets default values

 
Function Parameters:
Function Info:
Param - enable: boolean to enable (default false) * @
Param - noop: do not execute most functionality of the script */

set_level

set_level ( $level )

Function set_level
 Set the level to display

 
Function Parameters:
Function Info:
Param - level: level to display */

set_log_file

set_log_file ( $file )

Function set_log_file
 
Function Parameters:
Function Info:
Param - file: file to store log information */

addmessage

addmessage ( $level )

Function addmessage
 Checks if a message should be added for this level

 
Function Parameters:
Function Info:
Param - level: level of the message * @
Return - boolean: message to be added

wrapped_up

wrapped_up ( )

Function wrapped_up
 Do some module specific cleaning up: write messages to log file

Function Parameters:
Function Info: