ilTestGradingMessageBuilder Class Reference

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.

References $lng, and $testOBJ.

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

Member Function Documentation

addMessagePart()

ilTestGradingMessageBuilder::addMessagePart (   $msgPart )

private

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

Referenced by buildList(), and buildObligationsMsg().

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

Here is the caller graph for this function:

buildEctsGradeMsg()

ilTestGradingMessageBuilder::buildEctsGradeMsg ( )

private

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

References getEctsGrade().

Referenced by buildMessage().

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

Here is the call graph for this function:

Here is the caller graph for this function:

buildGradingMarkMsg()

ilTestGradingMessageBuilder::buildGradingMarkMsg ( )

private

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

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

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]", $this->getReachedPoints(), $markMsg);
                $markMsg = str_replace("[max]", $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 130 of file class.ilTestGradingMessageBuilder.php.

References isPassed().

Referenced by buildMessage().

        {
                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 210 of file class.ilTestGradingMessageBuilder.php.

References areObligationsAnswered(), getEctsGrade(), getMarkOfficial(), initListTemplate(), isPassed(), 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());
                }

                if( $this->testOBJ->getECTSOutput() )
                {
                        $this->populateListEntry($this->lng->txt('ects_grade'), $this->getEctsGrade());
                }
                
                $this->parseListTemplate();
        }

Here is the call graph for this function:

buildMessage()

ilTestGradingMessageBuilder::buildMessage

(

)

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

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

        {
                $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());
                }
        }

Here is the call graph for this function:

buildObligationsMsg()

ilTestGradingMessageBuilder::buildObligationsMsg ( )

private

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

References areObligationsAnswered().

Referenced by buildMessage().

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

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

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.

References $activeId.

Referenced by loadResultData().

        {
                return $this->activeId;
        }

Here is the caller graph for this function:

getEctsGrade()

ilTestGradingMessageBuilder::getEctsGrade ( )

private

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

Referenced by buildEctsGradeMsg(), and buildList().

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

Here is the caller graph for this function:

getFullMessage()

ilTestGradingMessageBuilder::getFullMessage ( )

private

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

Referenced by sendMessage().

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

Here is the caller graph for this function:

getList()

ilTestGradingMessageBuilder::getList

(

)

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

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

getMarkOfficial()

ilTestGradingMessageBuilder::getMarkOfficial ( )

private

Definition at line 153 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 158 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 180 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 163 of file class.ilTestGradingMessageBuilder.php.

References getMaxPoints(), and getReachedPoints().

Referenced by buildGradingMarkMsg().

        {
                $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 175 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 254 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 93 of file class.ilTestGradingMessageBuilder.php.

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

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

Here is the caller graph for this function:

loadResultData()

ilTestGradingMessageBuilder::loadResultData ( )

private

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

References getActiveId().

Referenced by buildList(), and buildMessage().

        {
                $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);
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

parseListTemplate()

ilTestGradingMessageBuilder::parseListTemplate ( )

private

Definition at line 267 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 259 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 98 of file class.ilTestGradingMessageBuilder.php.

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

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

Here is the call graph for this function:

setActiveId()

ilTestGradingMessageBuilder::setActiveId

(

$activeId

)

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

References $activeId.

        {
                $this->activeId = $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