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

Collaboration diagram for ilSystemStyleMessageStack:

Public Member Functions
	__construct (ilGlobalTemplateInterface $main_tpl)

	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...

	getUIComponentsMessages (\ILIAS\UI\Factory $f)
	Return Messages as UI Component. More...

	getJoinedMessages ()
	Return an array containing a string with all messages for each type. More...

	getMessages ()

	setMessages (array $messages)

	hasMessages ()
	Return wheter there are any message at all stored in the stack. More...

	sendMessages (bool $keep=true)
	Send messages via ilUtil to be displayed, still needed for messagees, that need to survive a redirect. More...

Protected Attributes
array	$messages = []

Private Attributes
ilGlobalTemplateInterface	$main_tpl

Detailed Description

Used to stack messages to be shown to the user.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilSystemStyleMessageStack::__construct ( ilGlobalTemplateInterface $main_tpl )

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

    {
        $this->main_tpl = $main_tpl;
    }

References $main_tpl.

Member Function Documentation

◆ addMessage()

ilSystemStyleMessageStack::addMessage ( ilSystemStyleMessage $message )

Add a message to be displayed by the stack.

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

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

References $message.

Referenced by ilSystemStyleOverviewGUI\checkStyleSettings(), ilSystemStyleMessageStackTest\testAddMessage(), ilSystemStyleMessageStackTest\testGetAndSetMessages(), ilSystemStyleMessageStackTest\testGetUIComponentsMessages(), 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 82 of file class.ilSystemStyleMessageStack.php.

                                       : array
    {
        $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 getUIComponentsMessages(), 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 97 of file class.ilSystemStyleMessageStack.php.

                                 : array
    {
        return $this->messages;
    }

References $messages.

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

Here is the caller graph for this function:

◆ getUIComponentsMessages()

ilSystemStyleMessageStack::getUIComponentsMessages ( \ILIAS\UI\Factory $f )

Return Messages as UI Component.

Returns: MessageBox[]

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

                                                                 : array
    {
        $messages = [];
        foreach ($this->getJoinedMessages() as $type => $joined_message) {
            switch ($type) {
                case ilSystemStyleMessage::TYPE_SUCCESS:
                    $messages[] = $f->messageBox()->success($joined_message);
                    break;
                case ilSystemStyleMessage::TYPE_INFO:
                    $messages[] = $f->messageBox()->info($joined_message);
                    break;
                case ilSystemStyleMessage::TYPE_ERROR:
                    $messages[] = $f->messageBox()->failure($joined_message);
                    break;
            }
        }
        return $messages;
    }

References Vendor\Package\$f, $messages, getJoinedMessages(), ilSystemStyleMessage\TYPE_ERROR, ilSystemStyleMessage\TYPE_INFO, and ilSystemStyleMessage\TYPE_SUCCESS.

Referenced by ilSystemStyleMessageStackTest\testGetUIComponentsMessages().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasMessages()

ilSystemStyleMessageStack::hasMessages ( )

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

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

                                 : bool
    {
        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.

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

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

References $message.

Referenced by ilSystemStyleMessageStackTest\testPrependMessage().

Here is the caller graph for this function:

◆ sendMessages()

ilSystemStyleMessageStack::sendMessages ( bool $keep = true )

Send messages via ilUtil to be displayed, still needed for messagees, that need to survive a redirect.

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

                                                   : void
    {
        foreach ($this->getJoinedMessages() as $type => $joined_message) {
            switch ($type) {
                case ilSystemStyleMessage::TYPE_SUCCESS:
                    $this->main_tpl->setOnScreenMessage('success', $joined_message, $keep);
                    break;
                case ilSystemStyleMessage::TYPE_INFO:
                    $this->main_tpl->setOnScreenMessage('info', $joined_message, $keep);
                    break;
                case ilSystemStyleMessage::TYPE_ERROR:
                    $this->main_tpl->setOnScreenMessage('failure', $joined_message, $keep);
                    break;
            }
        }
    }

References getJoinedMessages(), ilSystemStyleMessage\TYPE_ERROR, ilSystemStyleMessage\TYPE_INFO, and ilSystemStyleMessage\TYPE_SUCCESS.

Here is the call graph for this function:

◆ setMessages()

ilSystemStyleMessageStack::setMessages ( array $messages )

Parameters

ilSystemStyleMessage[] $messages

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

                                                : void
    {
        $this->messages = $messages;
    }

References $messages.

Field Documentation

◆ $main_tpl

ilGlobalTemplateInterface ilSystemStyleMessageStack::$main_tpl

private

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

Referenced by __construct().

◆ $messages

array ilSystemStyleMessageStack::$messages = []

protected

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

Referenced by getMessages(), getUIComponentsMessages(), and setMessages().

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

components/ILIAS/Style/System/classes/Utilities/class.ilSystemStyleMessageStack.php

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addMessage()

◆ getJoinedMessages()

◆ getMessages()

◆ getUIComponentsMessages()

◆ hasMessages()

◆ prependMessage()

◆ sendMessages()

◆ setMessages()

Field Documentation

◆ $main_tpl

◆ $messages