Collaboration diagram for ilTestGradingMessageBuilder:

Public Member Functions
	__construct (ilLanguage $lng, 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 ()

	buildObligationsMsg ()

	areObligationsAnswered ()

	buildEctsGradeMsg ()

	getEctsGrade ()

	populateListEntry ($label, $value)

	parseListTemplate ()

Private Attributes
	$lng

	$testOBJ

	$tpl

	$resultData

	$activeId

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilTestGradingMessageBuilder::__construct	(	ilLanguage	$lng,
		ilObjTest	$testOBJ
	)

Parameters

ilLanguage	$lng
ilObjTest	$testOBJ

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

    {
        $this->lng = $lng;
        $this->testOBJ = $testOBJ;
    }

References $lng, and $testOBJ.

Member Function Documentation

◆ addMessagePart()

ilTestGradingMessageBuilder::addMessagePart ( $msgPart )

private

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

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

Referenced by buildMessage().

Here is the caller graph for this function:

◆ areObligationsAnswered()

ilTestGradingMessageBuilder::areObligationsAnswered ( )

private

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

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

Referenced by buildList(), and buildObligationsMsg().

Here is the caller graph for this function:

◆ buildEctsGradeMsg()

ilTestGradingMessageBuilder::buildEctsGradeMsg ( )

private

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

    {
        return str_replace('[markects]', $this->getEctsGrade(), $this->lng->txt('mark_tst_ects'));
    }

References getEctsGrade().

Referenced by buildMessage().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildGradingMarkMsg()

ilTestGradingMessageBuilder::buildGradingMarkMsg ( )

private

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

    {
        $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]", $this->getReachedPoints(), $markMsg);
        $markMsg = str_replace("[max]", $this->getMaxPoints(), $markMsg);
        
        return $markMsg;
    }

References getMarkOfficial(), getMarkShort(), getMaxPoints(), getPercentage(), and getReachedPoints().

Referenced by buildMessage().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildGradingStatusMsg()

ilTestGradingMessageBuilder::buildGradingStatusMsg ( )

private

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

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

References isPassed().

Referenced by buildMessage().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildList()

ilTestGradingMessageBuilder::buildList ( )

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

    {
        $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());
        }
 
        if ($this->testOBJ->getECTSOutput()) {
            $this->populateListEntry($this->lng->txt('ects_grade'), $this->getEctsGrade());
        }
        
        $this->parseListTemplate();
    }

References areObligationsAnswered(), initListTemplate(), isPassed(), loadResultData(), parseListTemplate(), and populateListEntry().

Here is the call graph for this function:

◆ buildMessage()

ilTestGradingMessageBuilder::buildMessage ( )

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

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

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

Here is the call graph for this function:

◆ buildObligationsMsg()

ilTestGradingMessageBuilder::buildObligationsMsg ( )

private

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

    {
        if ($this->areObligationsAnswered()) {
            return $this->lng->txt('grading_obligations_answered_msg');
        }
 
        return $this->lng->txt('grading_obligations_missing_msg');
    }

References areObligationsAnswered().

Referenced by buildMessage().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getActiveId()

ilTestGradingMessageBuilder::getActiveId ( )

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

    {
        return $this->activeId;
    }

References $activeId.

Referenced by loadResultData().

Here is the caller graph for this function:

◆ getEctsGrade()

ilTestGradingMessageBuilder::getEctsGrade ( )

private

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

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

Referenced by buildEctsGradeMsg().

Here is the caller graph for this function:

◆ getFullMessage()

ilTestGradingMessageBuilder::getFullMessage ( )

private

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

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

Referenced by sendMessage().

Here is the caller graph for this function:

◆ getList()

ilTestGradingMessageBuilder::getList ( )

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

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

◆ getMarkOfficial()

ilTestGradingMessageBuilder::getMarkOfficial ( )

private

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

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

Referenced by buildGradingMarkMsg().

Here is the caller graph for this function:

◆ getMarkShort()

ilTestGradingMessageBuilder::getMarkShort ( )

private

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

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

Referenced by buildGradingMarkMsg().

Here is the caller graph for this function:

◆ getMaxPoints()

ilTestGradingMessageBuilder::getMaxPoints ( )

private

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

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

Referenced by buildGradingMarkMsg(), and getPercentage().

Here is the caller graph for this function:

◆ getPercentage()

ilTestGradingMessageBuilder::getPercentage ( )

private

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

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

References getMaxPoints(), getReachedPoints(), and sprintf.

Referenced by buildGradingMarkMsg().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getReachedPoints()

ilTestGradingMessageBuilder::getReachedPoints ( )

private

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

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

Referenced by buildGradingMarkMsg(), and getPercentage().

Here is the caller graph for this function:

◆ initListTemplate()

ilTestGradingMessageBuilder::initListTemplate ( )

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

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

Referenced by buildList().

Here is the caller graph for this function:

◆ isPassed()

ilTestGradingMessageBuilder::isPassed ( )

private

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

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

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

Here is the caller graph for this function:

◆ loadResultData()

ilTestGradingMessageBuilder::loadResultData ( )

private

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

    {
        $this->resultData = $this->testOBJ->getResultsForActiveId($this->getActiveId());
 
        if ($this->testOBJ->getECTSOutput()) {
            $ectsMark = $this->testOBJ->getECTSGrade(
                $this->testOBJ->getTotalPointsPassedArray(),
                $this->resultData['reached_points'],
                $this->resultData['max_points']
            );
 
            $this->resultData['ects_grade'] = strtoupper($ectsMark);
        }
    }

References getActiveId().

Referenced by buildList(), and buildMessage().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseListTemplate()

ilTestGradingMessageBuilder::parseListTemplate ( )

private

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

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

Referenced by buildList().

Here is the caller graph for this function:

◆ populateListEntry()

ilTestGradingMessageBuilder::populateListEntry	(	$label,
		$value
	)

private

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

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

Referenced by buildList().

Here is the caller graph for this function:

◆ sendMessage()

ilTestGradingMessageBuilder::sendMessage ( )

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

    {
        if (!$this->testOBJ->isShowGradingStatusEnabled()) {
            ilUtil::sendInfo($this->getFullMessage());
        } elseif ($this->isPassed()) {
            ilUtil::sendSuccess($this->getFullMessage());
        } else {
            ilUtil::sendFailure($this->getFullMessage());
        }
    }

References getFullMessage(), isPassed(), ilUtil\sendFailure(), ilUtil\sendInfo(), and ilUtil\sendSuccess().

Here is the call graph for this function:

◆ setActiveId()

ilTestGradingMessageBuilder::setActiveId ( $activeId )

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

    {
        $this->activeId = $activeId;
    }

References $activeId.

Field Documentation

◆ $activeId

ilTestGradingMessageBuilder::$activeId

private

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

Referenced by getActiveId(), and setActiveId().

◆ $lng

ilTestGradingMessageBuilder::$lng

private

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

Referenced by __construct().

◆ $resultData

ilTestGradingMessageBuilder::$resultData

private

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

◆ $testOBJ

ilTestGradingMessageBuilder::$testOBJ

private

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

Referenced by __construct().

◆ $tpl

ilTestGradingMessageBuilder::$tpl

private

Definition at line 26 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()

◆ buildEctsGradeMsg()

◆ buildGradingMarkMsg()

◆ buildGradingStatusMsg()

◆ buildList()

◆ buildMessage()

◆ buildObligationsMsg()

◆ getActiveId()

◆ getEctsGrade()

◆ getFullMessage()

◆ getList()

◆ getMarkOfficial()

◆ getMarkShort()

◆ getMaxPoints()

◆ getPercentage()

◆ getReachedPoints()

◆ initListTemplate()

◆ isPassed()

◆ loadResultData()

◆ parseListTemplate()

◆ populateListEntry()

◆ sendMessage()

◆ setActiveId()

Field Documentation

◆ $activeId

◆ $lng

◆ $resultData

◆ $testOBJ

◆ $tpl