Inheritance diagram for ilTestQuestionHeaderBlockBuilder:

Collaboration diagram for ilTestQuestionHeaderBlockBuilder:

Public Member Functions
	__construct (ilLanguage $lng)

	getHeaderMode ()

	setHeaderMode ($headerMode)

	getQuestionTitle ()

	setQuestionTitle ($questionTitle)

	getQuestionPoints ()

	setQuestionPoints ($questionPoints)

	setQuestionAnswered ($questionAnswered)

	getQuestionPosition ()

	setQuestionPosition ($questionPosition)

	getQuestionCount ()

	setQuestionCount ($questionCount)

	isQuestionPostponed ()

	isQuestionAnswered ()

	setQuestionPostponed ($questionPostponed)

	isQuestionObligatory ()

	setQuestionObligatory ($questionObligatory)

	getQuestionRelatedObjectives ()

	setQuestionRelatedObjectives ($questionRelatedObjectives)

	getPresentationTitle ()
	Get the presentation title of the question This is shown above the title line in a test run. More...

	getQuestionInfoHTML ()
	Get the additional question info and answering status This is shown below the title line in a test run. More...

	getHTML ()
	Get the HTML representation of the header block. More...

	getHTML ()
	Get the HTML representation of the header block. More...

Protected Member Functions
	buildQuestionPositionString ()

	buildQuestionPointsString ()

	buildQuestionPostponedString ()

	buildQuestionObligatoryString ()

	buildQuestionRelatedObjectivesString ()

Protected Attributes
	$lng

	$headerMode

	$questionTitle

	$questionPoints

	$questionPosition

	$questionCount

	$questionPostponed

	$questionObligatory

	$questionRelatedObjectives

	$questionAnswered

Detailed Description

Definition at line 12 of file class.ilTestQuestionHeaderBlockBuilder.php.

Constructor & Destructor Documentation

◆ __construct()

ilTestQuestionHeaderBlockBuilder::__construct ( ilLanguage $lng )

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

    {
        $this->lng = $lng;
        
        $this->headerMode = null;
        $this->questionTitle = '';
        $this->questionPoints = 0.0;
        $this->questionPosition = 0;
        $this->questionCount = 0;
        $this->questionPostponed = false;
        $this->questionObligatory = false;
        $this->questionRelatedObjectives = '';
    }

References $lng.

Member Function Documentation

◆ buildQuestionObligatoryString()

ilTestQuestionHeaderBlockBuilder::buildQuestionObligatoryString ( )

protected

Definition at line 259 of file class.ilTestQuestionHeaderBlockBuilder.php.

    {
        if ($this->isQuestionObligatory()) {
            return $this->lng->txt("tst_you_have_to_answer_this_question");
        }
        
        return '';
    }

References isQuestionObligatory().

Referenced by getHTML(), and getQuestionInfoHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildQuestionPointsString()

ilTestQuestionHeaderBlockBuilder::buildQuestionPointsString ( )

protected

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

    {
        if ($this->getQuestionPoints() == 1) {
            return "{$this->getQuestionPoints()} {$this->lng->txt('point')}";
        }
 
        return "{$this->getQuestionPoints()} {$this->lng->txt('points')}";
    }

References getQuestionPoints().

Referenced by getHTML(), and getQuestionInfoHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildQuestionPositionString()

ilTestQuestionHeaderBlockBuilder::buildQuestionPositionString ( )

protected

Definition at line 227 of file class.ilTestQuestionHeaderBlockBuilder.php.

    {
        if (!$this->getQuestionPosition()) {
            return '';
        }
        
        if ($this->getQuestionCount()) {
            return sprintf($this->lng->txt("tst_position"), $this->getQuestionPosition(), $this->getQuestionCount());
        }
 
        return sprintf($this->lng->txt("tst_position_without_total"), $this->getQuestionPosition());
    }

References getQuestionCount(), and getQuestionPosition().

Referenced by getHTML(), getPresentationTitle(), and getQuestionInfoHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildQuestionPostponedString()

ilTestQuestionHeaderBlockBuilder::buildQuestionPostponedString ( )

protected

Definition at line 250 of file class.ilTestQuestionHeaderBlockBuilder.php.

    {
        if ($this->isQuestionPostponed()) {
            return $this->lng->txt("postponed");
        }
        
        return '';
    }

References isQuestionPostponed().

Referenced by getHTML(), and getQuestionInfoHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildQuestionRelatedObjectivesString()

ilTestQuestionHeaderBlockBuilder::buildQuestionRelatedObjectivesString ( )

protected

Definition at line 268 of file class.ilTestQuestionHeaderBlockBuilder.php.

    {
        if (strlen($this->getQuestionRelatedObjectives())) {
            $label = $this->lng->txt('tst_res_lo_objectives_header');
            return $label . ': ' . $this->getQuestionRelatedObjectives();
        }
        
        return '';
    }

References getQuestionRelatedObjectives().

Referenced by getHTML(), and getQuestionInfoHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getHeaderMode()

ilTestQuestionHeaderBlockBuilder::getHeaderMode ( )

Returns: int

Definition at line 83 of file class.ilTestQuestionHeaderBlockBuilder.php.

    {
        return $this->headerMode;
    }

References $headerMode.

Referenced by getHTML(), getPresentationTitle(), and getQuestionInfoHTML().

Here is the caller graph for this function:

◆ getHTML()

ilTestQuestionHeaderBlockBuilder::getHTML ( )

Get the HTML representation of the header block.

Returns: string

Implements ilQuestionHeaderBlockBuilder.

Definition at line 358 of file class.ilTestQuestionHeaderBlockBuilder.php.

    {
        $headerBlock = $this->buildQuestionPositionString();
 
        switch ($this->getHeaderMode()) {
            case 1:
 
                $headerBlock .= " - " . $this->getQuestionTitle();
                $headerBlock .= $this->buildQuestionPostponedString();
                $headerBlock .= $this->buildQuestionObligatoryString();
                break;
            
            case 2:
 
                $headerBlock .= $this->buildQuestionPostponedString();
                $headerBlock .= $this->buildQuestionObligatoryString();
                break;
            
            case 0:
            default:
 
                $headerBlock .= " - " . $this->getQuestionTitle();
                $headerBlock .= $this->buildQuestionPostponedString();
// fau: testNav - put the points in parentheses here, not in building the string
                $headerBlock .= ' (' . $this->buildQuestionPointsString() . ')';
// fau.
                $headerBlock .= $this->buildQuestionObligatoryString();
        }
 
        $headerBlock .= $this->buildQuestionRelatedObjectivesString();
 
        return $headerBlock;
    }

References buildQuestionObligatoryString(), buildQuestionPointsString(), buildQuestionPositionString(), buildQuestionPostponedString(), buildQuestionRelatedObjectivesString(), getHeaderMode(), and getQuestionTitle().

Here is the call graph for this function:

◆ getPresentationTitle()

ilTestQuestionHeaderBlockBuilder::getPresentationTitle ( )

Get the presentation title of the question This is shown above the title line in a test run.

Returns: string

Definition at line 287 of file class.ilTestQuestionHeaderBlockBuilder.php.

    {
        switch ($this->getHeaderMode()) {
            case 2:     // neither titles nor points => show position as title
                return $this->buildQuestionPositionString();
                break;
 
            case 0:             // titles and points => show title here
            case 1:             // only titles => show title here
            default:
                return $this->getQuestionTitle();
        }
    }

References buildQuestionPositionString(), getHeaderMode(), and getQuestionTitle().

Here is the call graph for this function:

◆ getQuestionCount()

ilTestQuestionHeaderBlockBuilder::getQuestionCount ( )

Returns: int

Definition at line 156 of file class.ilTestQuestionHeaderBlockBuilder.php.

    {
        return $this->questionCount;
    }

References $questionCount.

Referenced by buildQuestionPositionString().

Here is the caller graph for this function:

◆ getQuestionInfoHTML()

ilTestQuestionHeaderBlockBuilder::getQuestionInfoHTML ( )

Get the additional question info and answering status This is shown below the title line in a test run.

Returns: string html code of the info block

Definition at line 307 of file class.ilTestQuestionHeaderBlockBuilder.php.

    {
        $tpl = new ilTemplate('tpl.tst_question_info.html', true, true, 'Modules/Test');
 
        // position and/or points
        switch ($this->getHeaderMode()) {
            case 1: // only titles =>  show position here
                $text = $this->buildQuestionPositionString();
                break;
 
            case 2: //  neither titles nor points => position is separate title, show nothing here
                $text = '';
                break;
 
            case 0: //  titles and points => show position and points here
            default:
                $text = $this->buildQuestionPositionString() . ' (' . $this->buildQuestionPointsString() . ')';
        }
        if ($this->isQuestionPostponed()) {
            $text .= ($text ? ', ' : '') . $this->buildQuestionPostponedString();
        }
 
        $tpl->setVariable('TXT_POSITION_POINTS', $text);
 
        // obligatory
        if ($this->isQuestionObligatory() && !$this->isQuestionAnswered()) {
            $tpl->setVariable('TXT_OBLIGATORY', $this->buildQuestionObligatoryString());
        }
 
        // objectives
        if (strlen($this->getQuestionRelatedObjectives())) {
            $tpl->setVariable('TXT_OBJECTIVES', $this->buildQuestionRelatedObjectivesString());
        }
 
        // answer status
        if ($this->isQuestionAnswered()) {
            $tpl->setVariable('HIDDEN_NOT_ANSWERED', 'hidden');
        } else {
            $tpl->setVariable('HIDDEN_ANSWERED', 'hidden');
        }
 
        $tpl->setVariable('SRC_ANSWERED', ilUtil::getImagePath('answered.svg'));
        $tpl->setVariable('SRC_NOT_ANSWERED', ilUtil::getImagePath('answered_not.svg'));
        $tpl->setVariable('TXT_ANSWERED', $this->lng->txt('tst_answer_status_answered'));
        $tpl->setVariable('TXT_NOT_ANSWERED', $this->lng->txt('tst_answer_status_not_answered'));
        $tpl->setVariable('TXT_EDITING', $this->lng->txt('tst_answer_status_editing'));
 
        return $tpl->get();
    }

References $text, $tpl, buildQuestionObligatoryString(), buildQuestionPointsString(), buildQuestionPositionString(), buildQuestionPostponedString(), buildQuestionRelatedObjectivesString(), getHeaderMode(), ilUtil\getImagePath(), getQuestionRelatedObjectives(), isQuestionAnswered(), isQuestionObligatory(), and isQuestionPostponed().

Here is the call graph for this function:

◆ getQuestionPoints()

ilTestQuestionHeaderBlockBuilder::getQuestionPoints ( )

Returns: float

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

    {
        return $this->questionPoints;
    }

References $questionPoints.

Referenced by buildQuestionPointsString().

Here is the caller graph for this function:

◆ getQuestionPosition()

ilTestQuestionHeaderBlockBuilder::getQuestionPosition ( )

Returns: int

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

    {
        return $this->questionPosition;
    }

References $questionPosition.

Referenced by buildQuestionPositionString().

Here is the caller graph for this function:

◆ getQuestionRelatedObjectives()

ilTestQuestionHeaderBlockBuilder::getQuestionRelatedObjectives ( )

Returns: string

Definition at line 214 of file class.ilTestQuestionHeaderBlockBuilder.php.

    {
        return $this->questionRelatedObjectives;
    }

References $questionRelatedObjectives.

Referenced by buildQuestionRelatedObjectivesString(), and getQuestionInfoHTML().

Here is the caller graph for this function:

◆ getQuestionTitle()

ilTestQuestionHeaderBlockBuilder::getQuestionTitle ( )

Returns: string

Definition at line 99 of file class.ilTestQuestionHeaderBlockBuilder.php.

    {
        return $this->questionTitle;
    }

References $questionTitle.

Referenced by getHTML(), and getPresentationTitle().

Here is the caller graph for this function:

◆ isQuestionAnswered()

ilTestQuestionHeaderBlockBuilder::isQuestionAnswered ( )

Returns: boolean | null

Definition at line 181 of file class.ilTestQuestionHeaderBlockBuilder.php.

    {
        return $this->questionAnswered;
    }

References $questionAnswered.

Referenced by getQuestionInfoHTML().

Here is the caller graph for this function:

◆ isQuestionObligatory()

ilTestQuestionHeaderBlockBuilder::isQuestionObligatory ( )

Returns: boolean

Definition at line 198 of file class.ilTestQuestionHeaderBlockBuilder.php.

    {
        return $this->questionObligatory;
    }

References $questionObligatory.

Referenced by buildQuestionObligatoryString(), and getQuestionInfoHTML().

Here is the caller graph for this function:

◆ isQuestionPostponed()

ilTestQuestionHeaderBlockBuilder::isQuestionPostponed ( )

Returns: boolean

Definition at line 172 of file class.ilTestQuestionHeaderBlockBuilder.php.

    {
        return $this->questionPostponed;
    }

References $questionPostponed.

Referenced by buildQuestionPostponedString(), and getQuestionInfoHTML().

Here is the caller graph for this function:

◆ setHeaderMode()

ilTestQuestionHeaderBlockBuilder::setHeaderMode ( $headerMode )

Parameters

int $headerMode

Definition at line 91 of file class.ilTestQuestionHeaderBlockBuilder.php.

    {
        $this->headerMode = $headerMode;
    }

References $headerMode.

◆ setQuestionAnswered()

ilTestQuestionHeaderBlockBuilder::setQuestionAnswered ( $questionAnswered )

Parameters

bool $questionAnswered

Definition at line 132 of file class.ilTestQuestionHeaderBlockBuilder.php.

    {
        $this->questionAnswered = $questionAnswered;
    }

References $questionAnswered.

◆ setQuestionCount()

ilTestQuestionHeaderBlockBuilder::setQuestionCount ( $questionCount )

Parameters

int $questionCount

Definition at line 164 of file class.ilTestQuestionHeaderBlockBuilder.php.

    {
        $this->questionCount = $questionCount;
    }

References $questionCount.

◆ setQuestionObligatory()

ilTestQuestionHeaderBlockBuilder::setQuestionObligatory ( $questionObligatory )

Parameters

boolean $questionObligatory

Definition at line 206 of file class.ilTestQuestionHeaderBlockBuilder.php.

    {
        $this->questionObligatory = $questionObligatory;
    }

References $questionObligatory.

◆ setQuestionPoints()

ilTestQuestionHeaderBlockBuilder::setQuestionPoints ( $questionPoints )

Parameters

float $questionPoints

Definition at line 123 of file class.ilTestQuestionHeaderBlockBuilder.php.

    {
        $this->questionPoints = $questionPoints;
    }

References $questionPoints.

◆ setQuestionPosition()

ilTestQuestionHeaderBlockBuilder::setQuestionPosition ( $questionPosition )

Parameters

int $questionPosition

Definition at line 148 of file class.ilTestQuestionHeaderBlockBuilder.php.

    {
        $this->questionPosition = $questionPosition;
    }

References $questionPosition.

◆ setQuestionPostponed()

ilTestQuestionHeaderBlockBuilder::setQuestionPostponed ( $questionPostponed )

Parameters

boolean $questionPostponed

Definition at line 190 of file class.ilTestQuestionHeaderBlockBuilder.php.

    {
        $this->questionPostponed = $questionPostponed;
    }

References $questionPostponed.

◆ setQuestionRelatedObjectives()

ilTestQuestionHeaderBlockBuilder::setQuestionRelatedObjectives ( $questionRelatedObjectives )

Parameters

string $questionRelatedObjectives

Definition at line 222 of file class.ilTestQuestionHeaderBlockBuilder.php.

    {
        $this->questionRelatedObjectives = $questionRelatedObjectives;
    }

References $questionRelatedObjectives.

◆ setQuestionTitle()

ilTestQuestionHeaderBlockBuilder::setQuestionTitle ( $questionTitle )

Parameters

string $questionTitle

Definition at line 107 of file class.ilTestQuestionHeaderBlockBuilder.php.

    {
        $this->questionTitle = $questionTitle;
    }

References $questionTitle.

Field Documentation

◆ $headerMode

ilTestQuestionHeaderBlockBuilder::$headerMode

protected

Definition at line 22 of file class.ilTestQuestionHeaderBlockBuilder.php.

Referenced by getHeaderMode(), and setHeaderMode().

◆ $lng

ilTestQuestionHeaderBlockBuilder::$lng

protected

Definition at line 17 of file class.ilTestQuestionHeaderBlockBuilder.php.

Referenced by __construct().

◆ $questionAnswered

ilTestQuestionHeaderBlockBuilder::$questionAnswered

protected

Definition at line 63 of file class.ilTestQuestionHeaderBlockBuilder.php.

Referenced by isQuestionAnswered(), and setQuestionAnswered().

◆ $questionCount

ilTestQuestionHeaderBlockBuilder::$questionCount

protected

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

Referenced by getQuestionCount(), and setQuestionCount().

◆ $questionObligatory

ilTestQuestionHeaderBlockBuilder::$questionObligatory

protected

Definition at line 52 of file class.ilTestQuestionHeaderBlockBuilder.php.

Referenced by isQuestionObligatory(), and setQuestionObligatory().

◆ $questionPoints

ilTestQuestionHeaderBlockBuilder::$questionPoints

protected

Definition at line 32 of file class.ilTestQuestionHeaderBlockBuilder.php.

Referenced by getQuestionPoints(), and setQuestionPoints().

◆ $questionPosition

ilTestQuestionHeaderBlockBuilder::$questionPosition

protected

Definition at line 37 of file class.ilTestQuestionHeaderBlockBuilder.php.

Referenced by getQuestionPosition(), and setQuestionPosition().

◆ $questionPostponed

ilTestQuestionHeaderBlockBuilder::$questionPostponed

protected

Definition at line 47 of file class.ilTestQuestionHeaderBlockBuilder.php.

Referenced by isQuestionPostponed(), and setQuestionPostponed().

◆ $questionRelatedObjectives

ilTestQuestionHeaderBlockBuilder::$questionRelatedObjectives

protected

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

Referenced by getQuestionRelatedObjectives(), and setQuestionRelatedObjectives().

◆ $questionTitle

ilTestQuestionHeaderBlockBuilder::$questionTitle

protected

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

Referenced by getQuestionTitle(), and setQuestionTitle().

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

Modules/Test/classes/class.ilTestQuestionHeaderBlockBuilder.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildQuestionObligatoryString()

◆ buildQuestionPointsString()

◆ buildQuestionPositionString()

◆ buildQuestionPostponedString()

◆ buildQuestionRelatedObjectivesString()

◆ getHeaderMode()

◆ getHTML()

◆ getPresentationTitle()

◆ getQuestionCount()

◆ getQuestionInfoHTML()

◆ getQuestionPoints()

◆ getQuestionPosition()

◆ getQuestionRelatedObjectives()

◆ getQuestionTitle()

◆ isQuestionAnswered()

◆ isQuestionObligatory()

◆ isQuestionPostponed()

◆ setHeaderMode()

◆ setQuestionAnswered()

◆ setQuestionCount()

◆ setQuestionObligatory()

◆ setQuestionPoints()

◆ setQuestionPosition()

◆ setQuestionPostponed()

◆ setQuestionRelatedObjectives()

◆ setQuestionTitle()

Field Documentation

◆ $headerMode

◆ $lng

◆ $questionAnswered

◆ $questionCount

◆ $questionObligatory

◆ $questionPoints

◆ $questionPosition

◆ $questionPostponed

◆ $questionRelatedObjectives

◆ $questionTitle