Inheritance diagram for ilTestQuestionHeaderBlockBuilder:

Collaboration diagram for ilTestQuestionHeaderBlockBuilder:

Public Member Functions
	__construct (ilLanguage $lng)

	getHeaderMode ()

	setHeaderMode ($headerMode)

	getQuestionTitle ()

	setQuestionTitle ($questionTitle)

	getQuestionPoints ()

	setQuestionPoints ($questionPoints)

	getQuestionPosition ()

	setQuestionPosition ($questionPosition)

	getQuestionCount ()

	setQuestionCount ($questionCount)

	isQuestionPostponed ()

	setQuestionPostponed ($questionPostponed)

	isQuestionObligatory ()

	setQuestionObligatory ($questionObligatory)

	getQuestionRelatedObjectives ()

	setQuestionRelatedObjectives ($questionRelatedObjectives)

	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

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilTestQuestionHeaderBlockBuilder::__construct ( ilLanguage $lng )

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

References $lng.

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

Member Function Documentation

◆ buildQuestionObligatoryString()

ilTestQuestionHeaderBlockBuilder::buildQuestionObligatoryString ( )

protected

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

References isQuestionObligatory().

Referenced by getHTML().

         {
                 if( $this->isQuestionObligatory() )
                 {
                         $obligatoryText = $this->lng->txt("tst_you_have_to_answer_this_question");
                         return '<br /><span class="obligatory" style="font-size:small">'.$obligatoryText.'</span>';
                 }
                 
                 return '';
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildQuestionPointsString()

ilTestQuestionHeaderBlockBuilder::buildQuestionPointsString ( )

protected

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

References getQuestionPoints().

Referenced by getHTML().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildQuestionPositionString()

ilTestQuestionHeaderBlockBuilder::buildQuestionPositionString ( )

protected

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

References getQuestionCount(), and getQuestionPosition().

Referenced by getHTML().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildQuestionPostponedString()

ilTestQuestionHeaderBlockBuilder::buildQuestionPostponedString ( )

protected

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

References isQuestionPostponed().

Referenced by getHTML().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildQuestionRelatedObjectivesString()

ilTestQuestionHeaderBlockBuilder::buildQuestionRelatedObjectivesString ( )

protected

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

References getQuestionRelatedObjectives().

Referenced by getHTML().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getHeaderMode()

ilTestQuestionHeaderBlockBuilder::getHeaderMode ( )

Returns: int

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

References $headerMode.

Referenced by getHTML().

         {
                 return $this->headerMode;
         }

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

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

         {
                 $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();
                                 $headerBlock .= $this->buildQuestionPointsString();
                                 $headerBlock .= $this->buildQuestionObligatoryString();
                 }
 
                 $headerBlock .= $this->buildQuestionRelatedObjectivesString();
 
                 return $headerBlock;
         }

Here is the call graph for this function:

◆ getQuestionCount()

ilTestQuestionHeaderBlockBuilder::getQuestionCount ( )

Returns: int

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

References $questionCount.

Referenced by buildQuestionPositionString().

         {
                 return $this->questionCount;
         }

Here is the caller graph for this function:

◆ getQuestionPoints()

ilTestQuestionHeaderBlockBuilder::getQuestionPoints ( )

Returns: float

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

References $questionPoints.

Referenced by buildQuestionPointsString().

         {
                 return $this->questionPoints;
         }

Here is the caller graph for this function:

◆ getQuestionPosition()

ilTestQuestionHeaderBlockBuilder::getQuestionPosition ( )

Returns: int

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

References $questionPosition.

Referenced by buildQuestionPositionString().

         {
                 return $this->questionPosition;
         }

Here is the caller graph for this function:

◆ getQuestionRelatedObjectives()

ilTestQuestionHeaderBlockBuilder::getQuestionRelatedObjectives ( )

Returns: string

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

References $questionRelatedObjectives.

Referenced by buildQuestionRelatedObjectivesString().

         {
                 return $this->questionRelatedObjectives;
         }

Here is the caller graph for this function:

◆ getQuestionTitle()

ilTestQuestionHeaderBlockBuilder::getQuestionTitle ( )

Returns: string

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

References $questionTitle.

         {
                 return $this->questionTitle;
         }

◆ isQuestionObligatory()

ilTestQuestionHeaderBlockBuilder::isQuestionObligatory ( )

Returns: boolean

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

References $questionObligatory.

Referenced by buildQuestionObligatoryString().

         {
                 return $this->questionObligatory;
         }

Here is the caller graph for this function:

◆ isQuestionPostponed()

ilTestQuestionHeaderBlockBuilder::isQuestionPostponed ( )

Returns: boolean

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

References $questionPostponed.

Referenced by buildQuestionPostponedString().

         {
                 return $this->questionPostponed;
         }

Here is the caller graph for this function:

◆ setHeaderMode()

ilTestQuestionHeaderBlockBuilder::setHeaderMode ( $headerMode )

Parameters

int $headerMode

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

References $headerMode.

         {
                 $this->headerMode = $headerMode;
         }

◆ setQuestionCount()

ilTestQuestionHeaderBlockBuilder::setQuestionCount ( $questionCount )

Parameters

int $questionCount

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

References $questionCount.

         {
                 $this->questionCount = $questionCount;
         }

◆ setQuestionObligatory()

ilTestQuestionHeaderBlockBuilder::setQuestionObligatory ( $questionObligatory )

Parameters

boolean $questionObligatory

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

References $questionObligatory.

         {
                 $this->questionObligatory = $questionObligatory;
         }

◆ setQuestionPoints()

ilTestQuestionHeaderBlockBuilder::setQuestionPoints ( $questionPoints )

Parameters

float $questionPoints

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

References $questionPoints.

         {
                 $this->questionPoints = $questionPoints;
         }

◆ setQuestionPosition()

ilTestQuestionHeaderBlockBuilder::setQuestionPosition ( $questionPosition )

Parameters

int $questionPosition

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

References $questionPosition.

         {
                 $this->questionPosition = $questionPosition;
         }

◆ setQuestionPostponed()

ilTestQuestionHeaderBlockBuilder::setQuestionPostponed ( $questionPostponed )

Parameters

boolean $questionPostponed

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

References $questionPostponed.

         {
                 $this->questionPostponed = $questionPostponed;
         }

◆ setQuestionRelatedObjectives()

ilTestQuestionHeaderBlockBuilder::setQuestionRelatedObjectives ( $questionRelatedObjectives )

Parameters

string $questionRelatedObjectives

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

References $questionRelatedObjectives.

         {
                 $this->questionRelatedObjectives = $questionRelatedObjectives;
         }

◆ setQuestionTitle()

ilTestQuestionHeaderBlockBuilder::setQuestionTitle ( $questionTitle )

Parameters

string $questionTitle

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

References $questionTitle.

         {
                 $this->questionTitle = $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().

◆ $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()

◆ getQuestionCount()

◆ getQuestionPoints()

◆ getQuestionPosition()

◆ getQuestionRelatedObjectives()

◆ getQuestionTitle()

◆ isQuestionObligatory()

◆ isQuestionPostponed()

◆ setHeaderMode()

◆ setQuestionCount()

◆ setQuestionObligatory()

◆ setQuestionPoints()

◆ setQuestionPosition()

◆ setQuestionPostponed()

◆ setQuestionRelatedObjectives()

◆ setQuestionTitle()

Field Documentation

◆ $headerMode

◆ $lng

◆ $questionCount

◆ $questionObligatory

◆ $questionPoints

◆ $questionPosition

◆ $questionPostponed

◆ $questionRelatedObjectives

◆ $questionTitle