Class Message 

ModuleBase
   |
   +----Message

Located in File: Program_Root/message.inc.php

Class Message 
 This is an abstract class that gets extended by DebugMessage and
 ErrorMessage
Class Variable Summary
$name
Default Value: ->"Message"<-
$messages
Default Value: ->array()<-
$enabled
Default Value: ->false<-
$noop
Default Value: -><-
$translator
Default Value: -><-
$shown
Default Value: ->false<-
$content
Default Value: -><-

Method Summary
Message ( )
Constructor
execlevel ( )
Get execution level
set_noop ( $bool )
Set No Operation to a value
noop ( )
Turn of operation (No Operation)
addmessage ( $level )
Test to add message
add_message ( $message, [$module = UNKNOWN], [$msglevel = DEFAULT_LEVEL] )
Add the message to the messages array (depricated) This routine is depricated. The add-function should be used.
message_added ( $msglevel, [$module = ""], [$message = ""] )
Function after a message is added
add ( $msglevel, $module, $message, [$var1 = ""], [$var2 = ""], [$var3 = ""], [$var4 = ""], [$var5 = ""], [$var6 = ""], [$var7 = ""], [$var8 = ""], [$var9 = ""], [$var10 = ""], [$var11 = ""], [$var12 = ""] )
Add the message to the messages array
message_array ( $m_array )
Add a whole array to the message array
display ( )
Display the messages
wrapped_up ( )
Add some functionality after wrapping up
wrap_up ( )
Wrap up

Variable Detail

$name

$messages

$enabled

$noop

$translator

$shown

$content

Function Detail

Message

Message ( )

Constructor
Function Parameters:
Function Info:

execlevel

execlevel ( )

Get execution level 
 This is for compatibility with Module
Function Parameters:
Function Info:

set_noop

set_noop ( $bool )

Set No Operation to a value
Function Parameters:
- $bool: boolean value for operation
Function Info:

noop

noop ( )

Turn of operation (No Operation)
Function Parameters:
Function Info:

addmessage

addmessage ( $level )

Test to add message 
 This function should test if it is necessary to store this message,
 depending on the level
Function Parameters:
- $level: message level
Function Info:

add_message

add_message ( $message, [$module = UNKNOWN], [$msglevel = DEFAULT_LEVEL] )

Add the message to the messages array (depricated) This routine is depricated. The add-function should be used.
Function Parameters:
- $message: the message
- $module: the module that generated the message
- $msglevel: the messagelevel to store the message
Function Info:

message_added

message_added ( $msglevel, [$module = ""], [$message = ""] )

Function after a message is added 
 This is for the subclasses
Function Parameters:
- $msglevel: message level to use
- $module: name of the module which created the message
- $message: actual message
Function Info:

add

add ( $msglevel, $module, $message, [$var1 = ""], [$var2 = ""], [$var3 = ""], [$var4 = ""], [$var5 = ""], [$var6 = ""], [$var7 = ""], [$var8 = ""], [$var9 = ""], [$var10 = ""], [$var11 = ""], [$var12 = ""] )

Add the message to the messages array 
 This is the actual function that adds the message to the array, takes
 care of coloring and calls the translation function.
Function Parameters:
- $msglevel: message level
- $module: name of the module that added the message
- $message: the actual message, should contain %s for values
- $varx: the values to fill in in the message
Function Info:

message_array

message_array ( $m_array )

Add a whole array to the message array 
 This function is used for the debug messages created before the debug
 module is loaded
Function Parameters:
Function Info:

display

display ( )

Display the messages 
 Check if some content is already created. If so, show the content and
 display the messages seperately. If not, set the content to the
 messages and show the content.

 This should change to properly work with templates. The messages
 should be entered into the template.
Function Parameters:
Function Info:

wrapped_up

wrapped_up ( )

Add some functionality after wrapping up 
 This may be used in a subModule
Function Parameters:
Function Info:

wrap_up

wrap_up ( )

Wrap up 
 Print messages when breaking up, if not already shown
Function Parameters:
Function Info: