Inheritance diagram for ilTestQuestionHeaderBlockBuilder:

Collaboration diagram for ilTestQuestionHeaderBlockBuilder:

Public Member Functions
	__construct (private readonly ilLanguage $lng)

	getHeaderMode ()

	setHeaderMode (int $header_mode)

	getQuestionTitle ()

	setQuestionTitle (string $question_title)

	getQuestionPoints ()

	setQuestionPoints (float $question_points)

	setQuestionAnswered (bool $question_answered)

	getQuestionPosition ()

	setQuestionPosition (int $question_position)

	getQuestionCount ()

	setQuestionCount (int $question_count)

	isQuestionPostponed ()

	isQuestionAnswered ()

	setQuestionPostponed (bool $question_postponed)

	getQuestionRelatedObjectives ()

	setQuestionRelatedObjectives (string $question_related_objectives)

	getPresentationTitle ()

	getQuestionInfoHTML ()

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

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

Protected Member Functions
	getQuestionTitleForHTMLOutput ()

	buildQuestionPositionString ()

	buildQuestionPointsString ()

	buildQuestionPostponedString ()

	buildQuestionRelatedObjectivesString ()

Protected Attributes
int	$header_mode = null

string	$question_title = ''

float	$question_points = 0.0

int	$question_position = 0

int	$question_count = 0

bool	$question_postponed = false

string	$question_related_objectives = ''

bool	$question_answered = null

Detailed Description

Author: Björn Heyser bheys.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de

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

Constructor & Destructor Documentation

◆ __construct()

ilTestQuestionHeaderBlockBuilder::__construct ( private readonly ilLanguage $lng )

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

37 {

38 }

Member Function Documentation

◆ buildQuestionPointsString()

ilTestQuestionHeaderBlockBuilder::buildQuestionPointsString ( )

protected

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

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

References getQuestionPoints().

Referenced by getHTML(), getPresentationTitle(), 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 125 of file class.ilTestQuestionHeaderBlockBuilder.php.

                                                    : string
    {
        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(), getQuestionPosition(), and ILIAS\Repository\lng().

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 147 of file class.ilTestQuestionHeaderBlockBuilder.php.

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

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

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 156 of file class.ilTestQuestionHeaderBlockBuilder.php.

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

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

Referenced by getHTML(), and getQuestionInfoHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getHeaderMode()

ilTestQuestionHeaderBlockBuilder::getHeaderMode ( )

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

                                   : ?int
    {
        return $this->header_mode;
    }

References $header_mode.

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 229 of file class.ilTestQuestionHeaderBlockBuilder.php.

                             : string
    {
        $header_block = $this->buildQuestionPositionString();
 
        switch ($this->getHeaderMode()) {
            case 1:
                $header_block .= " - " . $this->getQuestionTitleForHTMLOutput();
                $header_block .= $this->buildQuestionPostponedString();
                break;
 
            case 2:
                $header_block .= $this->buildQuestionPostponedString();
                break;
 
            case 0:
            default:
 
                $header_block .= " - " . $this->getQuestionTitleForHTMLOutput();
                $header_block .= $this->buildQuestionPostponedString();
                $header_block .= ' (' . $this->buildQuestionPointsString() . ')';
        }
 
        $header_block .= $this->buildQuestionRelatedObjectivesString();
 
        return $header_block;
    }

References buildQuestionPointsString(), buildQuestionPositionString(), buildQuestionPostponedString(), buildQuestionRelatedObjectivesString(), getHeaderMode(), and getQuestionTitleForHTMLOutput().

Here is the call graph for this function:

◆ getPresentationTitle()

ilTestQuestionHeaderBlockBuilder::getPresentationTitle ( )

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

                                          : string
    {
        switch ($this->getHeaderMode()) {
            case 3:     // only points => show no title here
                return $this->buildQuestionPointsString();
                break;
            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 buildQuestionPointsString(), buildQuestionPositionString(), getHeaderMode(), and getQuestionTitle().

Here is the call graph for this function:

◆ getQuestionCount()

ilTestQuestionHeaderBlockBuilder::getQuestionCount ( )

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

                                      : int
    {
        return $this->question_count;
    }

References $question_count.

Referenced by buildQuestionPositionString().

Here is the caller graph for this function:

◆ getQuestionInfoHTML()

ilTestQuestionHeaderBlockBuilder::getQuestionInfoHTML ( )

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

                                         : string
    {
        $tpl = new ilTemplate('tpl.tst_question_info.html', true, true, 'components/ILIAS/Test');
 
        // position and/or points
        switch ($this->getHeaderMode()) {
            case 1: // only titles =>  show position here
                $text = $this->buildQuestionPositionString();
                break;
 
            case 3: // only points => show nothing 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);
 
        if (strlen($this->getQuestionRelatedObjectives())) {
            $tpl->setVariable('TXT_OBJECTIVES', $this->buildQuestionRelatedObjectivesString());
        }
 
        if ($this->isQuestionAnswered()) {
            $tpl->setVariable('HIDDEN_NOT_ANSWERED', 'hidden');
        } else {
            $tpl->setVariable('HIDDEN_ANSWERED', 'hidden');
        }
 
        $tpl->setVariable('SRC_ANSWERED', ilUtil::getImagePath('object/answered.svg'));
        $tpl->setVariable('SRC_NOT_ANSWERED', ilUtil::getImagePath('object/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, ILIAS\News\Common\Table\$tpl, buildQuestionPointsString(), buildQuestionPositionString(), buildQuestionPostponedString(), buildQuestionRelatedObjectivesString(), ILIAS\UICore\GlobalTemplate\get(), getHeaderMode(), ilUtil\getImagePath(), getQuestionRelatedObjectives(), isQuestionAnswered(), isQuestionPostponed(), ILIAS\Repository\lng(), and ILIAS\UICore\GlobalTemplate\setVariable().

Here is the call graph for this function:

◆ getQuestionPoints()

ilTestQuestionHeaderBlockBuilder::getQuestionPoints ( )

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

                                       : float
    {
        return $this->question_points;
    }

References $question_points.

Referenced by buildQuestionPointsString().

Here is the caller graph for this function:

◆ getQuestionPosition()

ilTestQuestionHeaderBlockBuilder::getQuestionPosition ( )

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

                                         : int
    {
        return $this->question_position;
    }

References $question_position.

Referenced by buildQuestionPositionString().

Here is the caller graph for this function:

◆ getQuestionRelatedObjectives()

ilTestQuestionHeaderBlockBuilder::getQuestionRelatedObjectives ( )

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

                                                  : string
    {
        return $this->question_related_objectives;
    }

References $question_related_objectives.

Referenced by buildQuestionRelatedObjectivesString(), and getQuestionInfoHTML().

Here is the caller graph for this function:

◆ getQuestionTitle()

ilTestQuestionHeaderBlockBuilder::getQuestionTitle ( )

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

                                      : string
    {
        return $this->question_title;
    }

References $question_title.

Referenced by getPresentationTitle(), and getQuestionTitleForHTMLOutput().

Here is the caller graph for this function:

◆ getQuestionTitleForHTMLOutput()

ilTestQuestionHeaderBlockBuilder::getQuestionTitleForHTMLOutput ( )

protected

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

                                                      : string
    {
        return htmlspecialchars($this->getQuestionTitle(), ENT_QUOTES | ENT_SUBSTITUTE, 'UTF-8');
    }

References getQuestionTitle().

Referenced by getHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isQuestionAnswered()

ilTestQuestionHeaderBlockBuilder::isQuestionAnswered ( )

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

                                        : ?bool
    {
        return $this->question_answered;
    }

References $question_answered.

Referenced by getQuestionInfoHTML().

Here is the caller graph for this function:

◆ isQuestionPostponed()

ilTestQuestionHeaderBlockBuilder::isQuestionPostponed ( )

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

                                         : bool
    {
        return $this->question_postponed;
    }

References $question_postponed.

Referenced by buildQuestionPostponedString(), and getQuestionInfoHTML().

Here is the caller graph for this function:

◆ setHeaderMode()

ilTestQuestionHeaderBlockBuilder::setHeaderMode ( int $header_mode )

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

                                                   : void
    {
        $this->header_mode = $header_mode;
    }

References $header_mode.

◆ setQuestionAnswered()

ilTestQuestionHeaderBlockBuilder::setQuestionAnswered ( bool $question_answered )

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

                                                                : void
    {
        $this->question_answered = $question_answered;
    }

References $question_answered.

◆ setQuestionCount()

ilTestQuestionHeaderBlockBuilder::setQuestionCount ( int $question_count )

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

                                                         : void
    {
        $this->question_count = $question_count;
    }

References $question_count.

◆ setQuestionPoints()

ilTestQuestionHeaderBlockBuilder::setQuestionPoints ( float $question_points )

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

                                                             : void
    {
        $this->question_points = $question_points;
    }

References $question_points.

◆ setQuestionPosition()

ilTestQuestionHeaderBlockBuilder::setQuestionPosition ( int $question_position )

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

                                                               : void
    {
        $this->question_position = $question_position;
    }

References $question_position.

◆ setQuestionPostponed()

ilTestQuestionHeaderBlockBuilder::setQuestionPostponed ( bool $question_postponed )

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

                                                                  : void
    {
        $this->question_postponed = $question_postponed;
    }

References $question_postponed.

◆ setQuestionRelatedObjectives()

ilTestQuestionHeaderBlockBuilder::setQuestionRelatedObjectives ( string $question_related_objectives )

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

                                                                                     : void
    {
        $this->question_related_objectives = $question_related_objectives;
    }

References $question_related_objectives.

◆ setQuestionTitle()

ilTestQuestionHeaderBlockBuilder::setQuestionTitle ( string $question_title )

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

                                                            : void
    {
        $this->question_title = $question_title;
    }

References $question_title.

Field Documentation

◆ $header_mode

int ilTestQuestionHeaderBlockBuilder::$header_mode = null

protected

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

Referenced by getHeaderMode(), and setHeaderMode().

◆ $question_answered

bool ilTestQuestionHeaderBlockBuilder::$question_answered = null

protected

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

Referenced by isQuestionAnswered(), and setQuestionAnswered().

◆ $question_count

int ilTestQuestionHeaderBlockBuilder::$question_count = 0

protected

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

Referenced by getQuestionCount(), and setQuestionCount().

◆ $question_points

float ilTestQuestionHeaderBlockBuilder::$question_points = 0.0

protected

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

Referenced by getQuestionPoints(), and setQuestionPoints().

◆ $question_position

int ilTestQuestionHeaderBlockBuilder::$question_position = 0

protected

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

Referenced by getQuestionPosition(), and setQuestionPosition().

◆ $question_postponed

bool ilTestQuestionHeaderBlockBuilder::$question_postponed = false

protected

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

Referenced by isQuestionPostponed(), and setQuestionPostponed().

◆ $question_related_objectives

string ilTestQuestionHeaderBlockBuilder::$question_related_objectives = ''

protected

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

Referenced by getQuestionRelatedObjectives(), and setQuestionRelatedObjectives().

◆ $question_title

string ilTestQuestionHeaderBlockBuilder::$question_title = ''

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:

components/ILIAS/Test/classes/class.ilTestQuestionHeaderBlockBuilder.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildQuestionPointsString()

◆ buildQuestionPositionString()

◆ buildQuestionPostponedString()

◆ buildQuestionRelatedObjectivesString()

◆ getHeaderMode()

◆ getHTML()

◆ getPresentationTitle()

◆ getQuestionCount()

◆ getQuestionInfoHTML()

◆ getQuestionPoints()

◆ getQuestionPosition()

◆ getQuestionRelatedObjectives()

◆ getQuestionTitle()

◆ getQuestionTitleForHTMLOutput()

◆ isQuestionAnswered()

◆ isQuestionPostponed()

◆ setHeaderMode()

◆ setQuestionAnswered()

◆ setQuestionCount()

◆ setQuestionPoints()

◆ setQuestionPosition()

◆ setQuestionPostponed()

◆ setQuestionRelatedObjectives()

◆ setQuestionTitle()

Field Documentation

◆ $header_mode

◆ $question_answered

◆ $question_count

◆ $question_points

◆ $question_position

◆ $question_postponed

◆ $question_related_objectives

◆ $question_title