ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
Public Member Functions | Protected Attributes
ilSystemStyleMessageStack Class Reference

Used to stack messages to be shown to the user. More...

+ Collaboration diagram for ilSystemStyleMessageStack:

Public Member Functions

 prependMessage (ilSystemStyleMessage $message)
 Add a message to be displayed before all others. More...
 
 addMessage (ilSystemStyleMessage $message)
 Add a message to be displayed by the stack. More...
 
 sendMessages ($keep=false)
 Send messages via ilUtil to be displayed. More...
 
 getJoinedMessages ()
 Return an array containing a string with all messages for each type. More...
 
 getMessages ()
 
 setMessages ($messages)
 
 hasMessages ()
 Return wheter there are any message at all stored in the stack. More...
 

Protected Attributes

 $messages = array()
 

Detailed Description

Used to stack messages to be shown to the user.

Mostly used in ilUtil-Classes to present via ilUtil::sendMessage()

Author
Timon Amstutz timon.nosp@m..ams.nosp@m.tutz@.nosp@m.ilub.nosp@m..unib.nosp@m.e.ch
Version
$Id$*

Definition at line 9 of file class.ilSystemStyleMessageStack.php.

Member Function Documentation

◆ addMessage()

ilSystemStyleMessageStack::addMessage ( ilSystemStyleMessage  $message)

Add a message to be displayed by the stack.

Parameters
ilSystemStyleMessage$message

Definition at line 30 of file class.ilSystemStyleMessageStack.php.

30 {
31 $this->messages[] = $message;
32 }

Referenced by ilSystemStyleOverviewGUI\checkDeletable(), ilSystemStyleOverviewGUI\checkStyleSettings(), ilSystemStyleSettingsGUI\saveStyle(), ilSystemStyleMessageStackTest\testAddMessage(), ilSystemStyleMessageStackTest\testGetAndSetMessages(), ilSystemStyleMessageStackTest\testHasMessages(), and ilSystemStyleMessageStackTest\testJoinedMessages().

+ Here is the caller graph for this function:

◆ getJoinedMessages()

ilSystemStyleMessageStack::getJoinedMessages ( )

Return an array containing a string with all messages for each type.

Returns
string[]

Definition at line 60 of file class.ilSystemStyleMessageStack.php.

60 {
61 $joined_messages = [];
62 foreach($this->getMessages() as $message){
63 if(!array_key_exists($message->getTypeId(),$joined_messages)){
64 $joined_messages[$message->getTypeId()] = "";
65 }
66 $joined_messages[$message->getTypeId()] .= $message->getMessageOutput();
67 }
68 return $joined_messages;
69 }

References getMessages().

Referenced by sendMessages(), and ilSystemStyleMessageStackTest\testJoinedMessages().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getMessages()

ilSystemStyleMessageStack::getMessages ( )
Returns
ilSystemStyleMessage[]

Definition at line 74 of file class.ilSystemStyleMessageStack.php.

75 {
76 return $this->messages;
77 }

References $messages.

Referenced by getJoinedMessages(), hasMessages(), ilSystemStyleMessageStackTest\testAddMessage(), ilSystemStyleMessageStackTest\testGetAndSetMessages(), and ilSystemStyleMessageStackTest\testPrependMessage().

+ Here is the caller graph for this function:

◆ hasMessages()

ilSystemStyleMessageStack::hasMessages ( )

Return wheter there are any message at all stored in the stack.

Returns
bool

Definition at line 92 of file class.ilSystemStyleMessageStack.php.

92 {
93 return count($this->getMessages()) > 0;
94 }

References getMessages().

Referenced by ilSystemStyleMessageStackTest\testHasMessages().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ prependMessage()

ilSystemStyleMessageStack::prependMessage ( ilSystemStyleMessage  $message)

Add a message to be displayed before all others.

Parameters
ilSystemStyleMessage$message

Definition at line 21 of file class.ilSystemStyleMessageStack.php.

21 {
22 array_unshift($this->messages , $message);
23 }

Referenced by ilSystemStyleMessageStackTest\testPrependMessage().

+ Here is the caller graph for this function:

◆ sendMessages()

ilSystemStyleMessageStack::sendMessages (   $keep = false)

Send messages via ilUtil to be displayed.

Parameters
bool | false$keep

Definition at line 39 of file class.ilSystemStyleMessageStack.php.

39 {
40 foreach($this->getJoinedMessages() as $type => $joined_message){
41 switch($type){
42 case ilSystemStyleMessage::TYPE_SUCCESS:
43 ilUtil::sendSuccess($joined_message,$keep);
44 break;
45 case ilSystemStyleMessage::TYPE_INFO:
46 ilUtil::sendInfo($joined_message,$keep);
47 break;
48 case ilSystemStyleMessage::TYPE_ERROR:
49 ilUtil::sendFailure($joined_message,$keep);
50 break;
51 }
52 }
53 }
ilSystemStyleMessageStack\getJoinedMessages
getJoinedMessages()
Return an array containing a string with all messages for each type.
Definition: class.ilSystemStyleMessageStack.php:60
ilUtil\sendSuccess
static sendSuccess($a_info="", $a_keep=false)
Send Success Message to Screen.
Definition: class.ilUtil.php:4801
ilUtil\sendFailure
static sendFailure($a_info="", $a_keep=false)
Send Failure Message to Screen.
Definition: class.ilUtil.php:4771
ilUtil\sendInfo
static sendInfo($a_info="", $a_keep=false)
Send Info Message to Screen.
Definition: class.ilUtil.php:4757

References getJoinedMessages(), ilUtil\sendFailure(), ilUtil\sendInfo(), ilUtil\sendSuccess(), ilSystemStyleMessage\TYPE_ERROR, ilSystemStyleMessage\TYPE_INFO, and ilSystemStyleMessage\TYPE_SUCCESS.

+ Here is the call graph for this function:

◆ setMessages()

ilSystemStyleMessageStack::setMessages (   $messages)
Parameters
ilSystemStyleMessage[]$messages

Definition at line 82 of file class.ilSystemStyleMessageStack.php.

83 {
84 $this->messages = $messages;
85 }

References $messages.

Field Documentation

◆ $messages

ilSystemStyleMessageStack::$messages = array()
protected

Definition at line 14 of file class.ilSystemStyleMessageStack.php.

Referenced by getMessages(), and setMessages().

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