Collaboration diagram for ilTestGradingMessageBuilder:

Public Member Functions
	__construct (private ilLanguage $lng, private ilGlobalTemplateInterface $main_tpl, private ilObjTest $testOBJ)

	setActiveId ($activeId)

	getActiveId ()

	buildMessage ()

	sendMessage ()

	buildList ()

	initListTemplate ()

	getList ()

Private Member Functions
	addMessagePart ($msgPart)

	getFullMessage ()

	isPassed ()

	loadResultData ()

	buildGradingStatusMsg ()

	buildGradingMarkMsg ()

	getMarkOfficial ()

	getMarkShort ()

	getPercentage ()

	getReachedPoints ()

	getMaxPoints ()

	areObligationsAnswered ()

	populateListEntry ($label, $value)

	parseListTemplate ()

Private Attributes
	$tpl

	$resultData

	$activeId

	$container

array	$messageText = []

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

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

Parameters

ilLanguage	$lng
ilObjTest	$testOBJ

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

58 {

59 }

Member Function Documentation

◆ addMessagePart()

ilTestGradingMessageBuilder::addMessagePart ( $msgPart )

private

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

Referenced by buildMessage().

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

Here is the caller graph for this function:

◆ areObligationsAnswered()

ilTestGradingMessageBuilder::areObligationsAnswered ( )

private

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

Referenced by buildList().

                                              : bool
     {
         return (bool) $this->resultData['obligations_answered'];
     }

Here is the caller graph for this function:

◆ buildGradingMarkMsg()

ilTestGradingMessageBuilder::buildGradingMarkMsg ( )

private

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

References getMarkOfficial(), getMarkShort(), getMaxPoints(), getPercentage(), getReachedPoints(), and ILIAS\Repository\lng().

Referenced by buildMessage().

     {
         $markMsg = $this->lng->txt('grading_mark_msg');
 
         $markMsg = str_replace("[mark]", $this->getMarkOfficial(), $markMsg);
         $markMsg = str_replace("[markshort]", $this->getMarkShort(), $markMsg);
         $markMsg = str_replace("[percentage]", $this->getPercentage(), $markMsg);
         $markMsg = str_replace("[reached]", (string) $this->getReachedPoints(), $markMsg);
         $markMsg = str_replace("[max]", (string) $this->getMaxPoints(), $markMsg);
 
         return $markMsg;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildGradingStatusMsg()

ilTestGradingMessageBuilder::buildGradingStatusMsg ( )

private

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

References isPassed(), and ILIAS\Repository\lng().

Referenced by buildMessage().

                                             : string
     {
         if ($this->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 173 of file class.ilTestGradingMessageBuilder.php.

References areObligationsAnswered(), getMarkOfficial(), initListTemplate(), isPassed(), ILIAS\Repository\lng(), loadResultData(), parseListTemplate(), and populateListEntry().

     {
         $this->loadResultData();
 
         $this->initListTemplate();
 
         if ($this->testOBJ->isShowGradingStatusEnabled()) {
             $passedStatusLangVar = $this->isPassed() ? 'passed_official' : 'failed_official';
 
             $this->populateListEntry(
                 $this->lng->txt('passed_status'),
                 $this->lng->txt($passedStatusLangVar)
             );
         }
 
         if ($this->testOBJ->areObligationsEnabled()) {
             if ($this->areObligationsAnswered()) {
                 $obligAnsweredStatusLangVar = 'grading_obligations_answered_listentry';
             } else {
                 $obligAnsweredStatusLangVar = 'grading_obligations_missing_listentry';
             }
 
             $this->populateListEntry(
                 $this->lng->txt('grading_obligations_listlabel'),
                 $this->lng->txt($obligAnsweredStatusLangVar)
             );
         }
 
         if ($this->testOBJ->isShowGradingMarkEnabled()) {
             $this->populateListEntry($this->lng->txt('tst_mark'), $this->getMarkOfficial());
         }
 
         $this->parseListTemplate();
     }

Here is the call graph for this function:

◆ buildMessage()

ilTestGradingMessageBuilder::buildMessage ( )

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

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

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

Here is the call graph for this function:

◆ getActiveId()

ilTestGradingMessageBuilder::getActiveId ( )

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

References $activeId.

Referenced by loadResultData().

                                  : int
     {
         return $this->activeId;
     }

Here is the caller graph for this function:

◆ getFullMessage()

ilTestGradingMessageBuilder::getFullMessage ( )

private

Definition at line 89 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 227 of file class.ilTestGradingMessageBuilder.php.

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

◆ getMarkOfficial()

ilTestGradingMessageBuilder::getMarkOfficial ( )

private

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

Referenced by buildGradingMarkMsg(), and buildList().

     {
         return $this->resultData['mark_official'];
     }

Here is the caller graph for this function:

◆ getMarkShort()

ilTestGradingMessageBuilder::getMarkShort ( )

private

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

Referenced by buildGradingMarkMsg().

     {
         return $this->resultData['mark_short'];
     }

Here is the caller graph for this function:

◆ getMaxPoints()

ilTestGradingMessageBuilder::getMaxPoints ( )

private

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

Referenced by buildGradingMarkMsg(), and getPercentage().

     {
         return $this->resultData['max_points'];
     }

Here is the caller graph for this function:

◆ getPercentage()

ilTestGradingMessageBuilder::getPercentage ( )

private

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

References getMaxPoints(), and getReachedPoints().

Referenced by buildGradingMarkMsg().

                                     : string
     {
         $percentage = 0;
 
         if ($this->getMaxPoints() > 0) {
             $percentage = $this->getReachedPoints() / $this->getMaxPoints();
         }
 
         return sprintf("%.2f", $percentage);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getReachedPoints()

ilTestGradingMessageBuilder::getReachedPoints ( )

private

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

Referenced by buildGradingMarkMsg(), and getPercentage().

     {
         return $this->resultData['reached_points'];
     }

Here is the caller graph for this function:

◆ initListTemplate()

ilTestGradingMessageBuilder::initListTemplate ( )

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

Referenced by buildList().

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

Here is the caller graph for this function:

◆ isPassed()

ilTestGradingMessageBuilder::isPassed ( )

private

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

Referenced by buildGradingStatusMsg(), buildList(), and sendMessage().

                                : bool
     {
         return (bool) $this->resultData['passed'];
     }

Here is the caller graph for this function:

◆ loadResultData()

ilTestGradingMessageBuilder::loadResultData ( )

private

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

References getActiveId().

Referenced by buildList(), and buildMessage().

     {
         $this->resultData = $this->testOBJ->getResultsForActiveId($this->getActiveId());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseListTemplate()

ilTestGradingMessageBuilder::parseListTemplate ( )

private

Definition at line 221 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 213 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 99 of file class.ilTestGradingMessageBuilder.php.

References getFullMessage(), and isPassed().

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

Here is the call graph for this function:

◆ setActiveId()

ilTestGradingMessageBuilder::setActiveId ( $activeId )

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

References $activeId.

     {
         $this->activeId = $activeId;
     }

Field Documentation

◆ $activeId

ilTestGradingMessageBuilder::$activeId

private

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

Referenced by getActiveId(), and setActiveId().

◆ $container

ilTestGradingMessageBuilder::$container

private

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

◆ $messageText

array ilTestGradingMessageBuilder::$messageText = []

private

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

◆ $resultData

ilTestGradingMessageBuilder::$resultData

private

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

◆ $tpl

ilTestGradingMessageBuilder::$tpl

private

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

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

Modules/Test/classes/class.ilTestGradingMessageBuilder.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addMessagePart()

◆ areObligationsAnswered()

◆ buildGradingMarkMsg()

◆ buildGradingStatusMsg()

◆ buildList()

◆ buildMessage()

◆ getActiveId()

◆ getFullMessage()

◆ getList()

◆ getMarkOfficial()

◆ getMarkShort()

◆ getMaxPoints()

◆ getPercentage()

◆ getReachedPoints()

◆ initListTemplate()

◆ isPassed()

◆ loadResultData()

◆ parseListTemplate()

◆ populateListEntry()

◆ sendMessage()

◆ setActiveId()

Field Documentation

◆ $activeId

◆ $container

◆ $messageText

◆ $resultData

◆ $tpl