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 32 of file class.ilSystemStyleMessageStack.php.

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

References $message.

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 64 of file class.ilSystemStyleMessageStack.php.

    {
        $joined_messages = [];
        foreach ($this->getMessages() as $message) {
            if (!array_key_exists($message->getTypeId(), $joined_messages)) {
                $joined_messages[$message->getTypeId()] = "";
            }
            $joined_messages[$message->getTypeId()] .= $message->getMessageOutput();
        }
        return $joined_messages;
    }

References $message, and 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 79 of file class.ilSystemStyleMessageStack.php.

    {
        return $this->messages;
    }

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 97 of file class.ilSystemStyleMessageStack.php.

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

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 22 of file class.ilSystemStyleMessageStack.php.

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

References $message.

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 42 of file class.ilSystemStyleMessageStack.php.

    {
        foreach ($this->getJoinedMessages() as $type => $joined_message) {
            switch ($type) {
                case ilSystemStyleMessage::TYPE_SUCCESS:
                    ilUtil::sendSuccess($joined_message, $keep);
                    break;
                case ilSystemStyleMessage::TYPE_INFO:
                    ilUtil::sendInfo($joined_message, $keep);
                    break;
                case ilSystemStyleMessage::TYPE_ERROR:
                    ilUtil::sendFailure($joined_message, $keep);
                    break;
            }
        }
    }

References $type, 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 87 of file class.ilSystemStyleMessageStack.php.

    {
        $this->messages = $messages;
    }

References $messages.

Field Documentation

$messages

ilSystemStyleMessageStack::$messages = array()

protected

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

Referenced by getMessages(), and setMessages().

---

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

• Services/Style/System/classes/Utilities/class.ilSystemStyleMessageStack.php