class.ilSystemStyleMessageStack.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
use ILIAS\UI\Component\MessageBox\MessageBox;
 
class ilSystemStyleMessageStack
{
    protected array $messages = [];
    private ilGlobalTemplateInterface $main_tpl;
    public function __construct(ilGlobalTemplateInterface $main_tpl)
    {
        $this->main_tpl = $main_tpl;
    }
 
    public function prependMessage(ilSystemStyleMessage $message): void
    {
        array_unshift($this->messages, $message);
    }
 
    public function addMessage(ilSystemStyleMessage $message): void
    {
        $this->messages[] = $message;
    }
 
    public function getUIComponentsMessages(\ILIAS\UI\Factory $f): 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;
    }
 
    public function getJoinedMessages(): 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;
    }
 
    public function getMessages(): array
    {
        return $this->messages;
    }
 
    public function setMessages(array $messages): void
    {
        $this->messages = $messages;
    }
 
    public function hasMessages(): bool
    {
        return count($this->getMessages()) > 0;
    }
 
    public function sendMessages(bool $keep = true): 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;
            }
        }
    }
}