ilTestGradingMessageBuilder Class Reference

Collaboration diagram for ilTestGradingMessageBuilder:

Public Member Functions
	__construct (private ilLanguage $lng, private ilGlobalTemplateInterface $main_tpl, private ilObjTest $testOBJ, private readonly ParticipantResult $result)
	buildMessage ()
	sendMessage ()
	buildList ()
	initListTemplate ()
	getList ()

Private Member Functions
	addMessagePart ($msgPart)
	getFullMessage ()
	buildGradingStatusMsg ()
	buildGradingMarkMsg ()
	populateListEntry ($label, $value)
	parseListTemplate ()

Private Attributes
ilTemplate	$tpl
array	$messageText = []

Detailed Description

Definition at line 29 of file class.ilTestGradingMessageBuilder.php.

Constructor & Destructor Documentation

__construct()

ilTestGradingMessageBuilder::__construct	(	private ilLanguage	$lng,
		private ilGlobalTemplateInterface	$main_tpl,
		private ilObjTest	$testOBJ,
		private readonly ParticipantResult	$result
	)

Definition at line 38 of file class.ilTestGradingMessageBuilder.php.

      {
    }

Member Function Documentation

addMessagePart()

ilTestGradingMessageBuilder::addMessagePart (   $msgPart )

private

Definition at line 57 of file class.ilTestGradingMessageBuilder.php.

Referenced by buildMessage().

    {
        $this->messageText[] = $msgPart;
    }

Here is the caller graph for this function:

buildGradingMarkMsg()

ilTestGradingMessageBuilder::buildGradingMarkMsg ( )

private

Definition at line 87 of file class.ilTestGradingMessageBuilder.php.

References ILIAS\Repository\lng().

Referenced by buildMessage().

    {
        $mark_msg = $this->lng->txt('grading_mark_msg');

        $mark_msg = str_replace('[mark]', $this->result->getMarkOfficial(), $mark_msg);
        $mark_msg = str_replace('[markshort]', $this->result->getMarkShort(), $mark_msg);
        $mark_msg = str_replace('[percentage]', sprintf('%.2f', $this->result->getPercentage()), $mark_msg);
        $mark_msg = str_replace('[reached]', (string) $this->result->getReachedPoints(), $mark_msg);
        $mark_msg = str_replace('[max]', (string) $this->result->getMaxPoints(), $mark_msg);

        return $mark_msg;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildGradingStatusMsg()

ilTestGradingMessageBuilder::buildGradingStatusMsg ( )

private

Definition at line 78 of file class.ilTestGradingMessageBuilder.php.

References ILIAS\Repository\lng().

Referenced by buildMessage().

                                            : string
    {
        if ($this->result->isPassed()) {
            return $this->lng->txt('grading_status_passed_msg');
        }

        return $this->lng->txt('grading_status_failed_msg');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildList()

ilTestGradingMessageBuilder::buildList

(

)

Definition at line 100 of file class.ilTestGradingMessageBuilder.php.

References initListTemplate(), ILIAS\Repository\lng(), parseListTemplate(), and populateListEntry().

    {
        $this->initListTemplate();

        if ($this->testOBJ->isShowGradingStatusEnabled()) {
            $passedStatusLangVar = $this->result->isPassed() ? 'passed_official' : 'failed_official';

            $this->populateListEntry(
                $this->lng->txt('passed_status'),
                $this->lng->txt($passedStatusLangVar)
            );
        }

        if ($this->testOBJ->isShowGradingMarkEnabled()) {
            $this->populateListEntry($this->lng->txt('tst_mark'), $this->result->getMarkOfficial());
        }

        $this->parseListTemplate();
    }

Here is the call graph for this function:

buildMessage()

ilTestGradingMessageBuilder::buildMessage

(

)

Definition at line 46 of file class.ilTestGradingMessageBuilder.php.

References addMessagePart(), buildGradingMarkMsg(), and buildGradingStatusMsg().

    {
        if ($this->testOBJ->isShowGradingStatusEnabled()) {
            $this->addMessagePart($this->buildGradingStatusMsg());
        }

        if ($this->testOBJ->isShowGradingMarkEnabled()) {
            $this->addMessagePart($this->buildGradingMarkMsg());
        }
    }

Here is the call graph for this function:

getFullMessage()

ilTestGradingMessageBuilder::getFullMessage ( )

private

Definition at line 62 of file class.ilTestGradingMessageBuilder.php.

Referenced by sendMessage().

                                     : string
    {
        return implode(' ', $this->messageText);
    }

Here is the caller graph for this function:

getList()

ilTestGradingMessageBuilder::getList

(

)

Definition at line 139 of file class.ilTestGradingMessageBuilder.php.

                             : string
    {
        return $this->tpl->get();
    }

initListTemplate()

ilTestGradingMessageBuilder::initListTemplate

(

)

Definition at line 120 of file class.ilTestGradingMessageBuilder.php.

Referenced by buildList().

    {
        $this->tpl = new ilTemplate('tpl.tst_grading_msg_list.html', true, true, 'components/ILIAS/Test');
    }

Here is the caller graph for this function:

parseListTemplate()

ilTestGradingMessageBuilder::parseListTemplate ( )

private

Definition at line 133 of file class.ilTestGradingMessageBuilder.php.

Referenced by buildList().

    {
        $this->tpl->setCurrentBlock('grading_msg_list');
        $this->tpl->parseCurrentBlock();
    }

Here is the caller graph for this function:

populateListEntry()

ilTestGradingMessageBuilder::populateListEntry (   $label,   $value  )

private

Definition at line 125 of file class.ilTestGradingMessageBuilder.php.

Referenced by buildList().

    {
        $this->tpl->setCurrentBlock('grading_msg_entry');
        $this->tpl->setVariable('LABEL', $label);
        $this->tpl->setVariable('VALUE', $value);
        $this->tpl->parseCurrentBlock();
    }

Here is the caller graph for this function:

sendMessage()

ilTestGradingMessageBuilder::sendMessage

(

)

Definition at line 67 of file class.ilTestGradingMessageBuilder.php.

References getFullMessage().

    {
        if (!$this->testOBJ->isShowGradingStatusEnabled()) {
            $this->main_tpl->setOnScreenMessage('info', $this->getFullMessage());
        } elseif ($this->result->isPassed()) {
            $this->main_tpl->setOnScreenMessage('success', $this->getFullMessage());
        } else {
            $this->main_tpl->setOnScreenMessage('info', $this->getFullMessage());
        }
    }

Here is the call graph for this function:

Field Documentation

$messageText

array< string > ilTestGradingMessageBuilder::$messageText = []

private

Definition at line 36 of file class.ilTestGradingMessageBuilder.php.

$tpl

ilTemplate ilTestGradingMessageBuilder::$tpl

private

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

---

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

• components/ILIAS/Test/classes/class.ilTestGradingMessageBuilder.php