Stud.IP  2.0 Revision 48548
 All Data Structures Namespaces Files Functions Variables Pages
Msg Class Reference
Collaboration diagram for Msg:
Collaboration graph

Public Member Functions

 Msg ()
 addMsg ($msg_code, $params='')
 checkMsgs ()
 displayAllMsg ($view_mode="line")
 displayMsg ($msg_code, $view_mode="line", $params=array())

Data Fields

 $msg
 $codes = array()
 $params

Member Function Documentation

addMsg (   $msg_code,
  $params = '' 
)

Adds the message defined by the submitted code to a queue

Parameters
int$msg_codea number referencing to a message in lib/resources/views/msg_resources.inc.php
mixed$paramsan array of msg-paramaters
checkMsgs ( )

Checks if there are any messages in the queue

Returns
bool true if messages have been queued, false otherwise
displayAllMsg (   $view_mode = "line")

Displays all queued messages

Parameters
string$view_modecan be "line" for embedded messages, "window" for separate messages
displayMsg (   $msg_code,
  $view_mode = "line",
  $params = array() 
)

Display a single message

Parameters
int$msg_codea number referencing to a message in lib/resources/views/msg_resources.inc.php
string$view_modecan be "line" for embedded messages, "window" for separate messages
mixed$paramsan array of paramaters to be placed into the message
Msg ( )

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

Field Documentation

$codes = array()
$msg
$params

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