msghandler Class Reference
[Message-Handler-Class]

List of all members.

Public Member Functions
	msghandler ()
	Class Constructor.
	_msghandler ()
	Class Destructor.
	msg_add ($msg)
	Adds a message to the message buffer array.
	msg_addfile ($msg, $file)
	Adds a message to a specified file.
	msg_addfull ($msg, $file=0)
	Adds a message to buffer and also to a specified file. In additional it includes a timestamp into the file message.
	msg_flushlist ()
	Empty the message buffer.
	msg_get ($mid)
	Returns a single message out of the message buffer.
	msg_getlist ()
	Returns the message buffer and empties it.
	msg_getsize ()
	Return number of messages in buffer.
	msg_getsize_byte ()
	Returns the messages buffer size in byte.
Public Attributes
	$msg_list = array()
	$msg_list_size_byte = 0

---

Constructor & Destructor Documentation

function msghandler::msghandler (   )

Class Constructor.

---

Member Function Documentation

function msghandler::_msghandler (   )

Class Destructor.

function msghandler::msg_add (  $  msg  )

Adds a message to the message buffer array. Parameters: $msg  = Message

function msghandler::msg_addfile (  $  msg, $  file )

Adds a message to a specified file. Parameters: $msg  = Message $file  = Name of log file with full path to it. Returns: Returns 'true' if everything has been all right else 'false'.

function msghandler::msg_addfull (  $  msg, $  file = 0 )

Adds a message to buffer and also to a specified file. In additional it includes a timestamp into the file message. Parameters: $msg  = Message to add. $file  = Name of log file with full path to it. Set to "0" if you won`t log it to a file. Returns: Returns 'true' if everything has been all right else 'false'.

function msghandler::msg_flushlist (   )

Empty the message buffer. Returns: Returns 'true' if everything has been all right else 'false'.

function msghandler::msg_get (  $  mid  )

Returns a single message out of the message buffer. Parameters: $mid  = Message ID Returns: Buffer message

function msghandler::msg_getlist (   )

Returns the message buffer and empties it. Returns: Message list

function msghandler::msg_getsize (   )

Return number of messages in buffer. Returns: Size of message buffer

function msghandler::msg_getsize_byte (   )

Returns the messages buffer size in byte. Returns: Size of message buffer in byte

---

Member Data Documentation

msghandler::$msg_list = array()

Message string list

msghandler::$msg_list_size_byte = 0

Includes the message buffer size in byte

---

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

• msghandler.php

---