Msg Class Reference

Collaboration diagram for Msg:

Public Member Functions
	__construct ()
	addMsg ($msg_code, $params='')
	checkMsgs ()
	displayAllMsg ($view_mode="line")
	displayMsg ($msg_code, $view_mode="line", $params=[])

Data Fields
	$msg
	$codes =[]
	$params

Constructor & Destructor Documentation

__construct()

__construct

(

)

Constructor for resource-messages. Loads lib/resources/views/msg_resources.inc.php

Member Function Documentation

addMsg()

addMsg	(		$msg_code,
			$params = ''
	)

Adds the message defined by the submitted code to a queue

Parameters

int	$msg_code	a number referencing to a message in lib/resources/views/msg_resources.inc.php
mixed	$params	an array of msg-paramaters

checkMsgs()

checkMsgs

(

)

Checks if there are any messages in the queue

Returns

bool true if messages have been queued, false otherwise

displayAllMsg()

displayAllMsg

(

$view_mode = "line"

)

Displays all queued messages

Parameters

string

$view_mode

can be "line" for embedded messages, "window" for separate messages

displayMsg()

displayMsg	(		$msg_code,
			$view_mode = "line",
			$params = []
	)

Display a single message

Parameters

int	$msg_code	a number referencing to a message in lib/resources/views/msg_resources.inc.php
string	$view_mode	can be "line" for embedded messages, "window" for separate messages
mixed	$params	an array of paramaters to be placed into the message

Field Documentation

$codes

$codes =[]

$msg

$msg

$params

$params

---

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

• lib/resources/views/Msg.class.php