ilPRGMessagePrinter Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilPRGMessagePrinter:

Public Member Functions
	__construct (ilPRGMessageCollection $collection, ilLanguage $lng, ilGlobalTemplateInterface $tpl)
	getMessageCollection (string $topic)
	showMessages (ilPRGMessageCollection $msg)

Protected Attributes
ilPRGMessageCollection	$collection
ilLanguage	$lng
ilGlobalTemplateInterface	$tpl

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Util around ilPRGMessageCollection factors and output collections.

Definition at line 25 of file ilPRGMessagePrinter.php.

Constructor & Destructor Documentation

__construct()

ilPRGMessagePrinter::__construct	(	ilPRGMessageCollection	$collection,
		ilLanguage	$lng,
		ilGlobalTemplateInterface	$tpl
	)

Definition at line 31 of file ilPRGMessagePrinter.php.

References $collection, $lng, $tpl, and ILIAS\Repository\lng().

      {
        $this->collection = $collection;
        $this->lng = $lng;
        $this->tpl = $tpl;
    }

Here is the call graph for this function:

Member Function Documentation

getMessageCollection()

ilPRGMessagePrinter::getMessageCollection

(

string

$topic

)

Definition at line 41 of file ilPRGMessagePrinter.php.

References ilPRGMessageCollection\withNewTopic().

                                                       : ilPRGMessageCollection
    {
        return $this->collection->withNewTopic($topic);
    }

Here is the call graph for this function:

showMessages()

ilPRGMessagePrinter::showMessages

(

ilPRGMessageCollection

$msg

)

Definition at line 46 of file ilPRGMessagePrinter.php.

References $message, $out, ilPRGMessageCollection\getDescription(), ilPRGMessageCollection\getErrors(), ilPRGMessageCollection\getSuccess(), ilPRGMessageCollection\hasErrors(), ilPRGMessageCollection\hasSuccess(), and ILIAS\Repository\lng().

                                                             : void
    {
        if ($msg->hasSuccess()) {
            $out = sprintf(
                $this->lng->txt($msg->getDescription()),
                count($msg->getSuccess())
            );
            $this->tpl->setOnScreenMessage("success", $out, true);
        }

        if ($msg->hasErrors()) {
            $errmsg = [];
            foreach ($msg->getErrors() as $err) {
                [$message, $rec_indentifier] = $err;
                $errmsg[] = sprintf('<li>%s (%s)</li>', $rec_indentifier, $this->lng->txt($message));
            }

            $out = sprintf(
                $this->lng->txt($msg->getDescription() . '_failed'),
                count($errmsg)
            )
            . '<ul>' . implode('', $errmsg) . '</ul>';

            $this->tpl->setOnScreenMessage("failure", $out, true);
        }
    }

Here is the call graph for this function:

Field Documentation

$collection

ilPRGMessageCollection ilPRGMessagePrinter::$collection

protected

Definition at line 27 of file ilPRGMessagePrinter.php.

Referenced by __construct().

$lng

ilLanguage ilPRGMessagePrinter::$lng

protected

Definition at line 28 of file ilPRGMessagePrinter.php.

Referenced by __construct().

$tpl

ilGlobalTemplateInterface ilPRGMessagePrinter::$tpl

protected

Definition at line 29 of file ilPRGMessagePrinter.php.

Referenced by __construct().

---

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

• Modules/StudyProgramme/classes/helpers/ilPRGMessagePrinter.php