Collaboration diagram for ilTestQuestionSideListGUI:

Public Member Functions
	__construct (ilCtrl $ctrl, ilLanguage $lng)

	getTargetGUI ()

	setTargetGUI ($targetGUI)

	getQuestionSummaryData ()

	setQuestionSummaryData ($questionSummaryData)

	getCurrentSequenceElement ()

	setCurrentSequenceElement ($currentSequenceElement)

	getCurrentPresentationMode ()

	setCurrentPresentationMode ($currentPresentationMode)

	isDisabled ()

	setDisabled ($disabled)

	getHTML ()

Protected Attributes
	$ctrl

	$lng

Private Member Functions
	buildPanel ()

	renderList ()

	buildLink ($sequenceElement)

Private Attributes
	$targetGUI

	$questionSummaryData

	$currentSequenceElement

	$currentPresentationMode

	$disabled

Detailed Description

Definition at line 25 of file class.ilTestQuestionSideListGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilTestQuestionSideListGUI::__construct	(	ilCtrl	$ctrl,
		ilLanguage	$lng
	)

Parameters

ilCtrl	$ctrl
ilLanguage	$lng

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

References $ctrl, $lng, ILIAS\Repository\ctrl(), ILIAS\UI\examples\Input\Field\Checkbox\disabled(), and ILIAS\Repository\lng().

     {
         $this->ctrl = $ctrl;
         $this->lng = $lng;
 
         $this->questionSummaryData = array();
         $this->currentSequenceElement = null;
         $this->disabled = false;
     }

Here is the call graph for this function:

Member Function Documentation

◆ buildLink()

ilTestQuestionSideListGUI::buildLink ( $sequenceElement )

private

Parameters

$row

Returns: string

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

References ILIAS\Repository\ctrl(), getCurrentPresentationMode(), getCurrentSequenceElement(), getTargetGUI(), and ilTestPlayerCommands\SHOW_QUESTION.

Referenced by renderList().

                                                 : string
     {
         $this->ctrl->setParameter(
             $this->getTargetGUI(),
             'pmode',
             ''
         );
 
         $this->ctrl->setParameter(
             $this->getTargetGUI(),
             'sequence',
             $sequenceElement
         );
 
         $href = $this->ctrl->getLinkTarget($this->getTargetGUI(), ilTestPlayerCommands::SHOW_QUESTION);
 
         $this->ctrl->setParameter(
             $this->getTargetGUI(),
             'pmode',
             $this->getCurrentPresentationMode()
         );
         $this->ctrl->setParameter(
             $this->getTargetGUI(),
             'sequence',
             $this->getCurrentSequenceElement()
         );
         return $href;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildPanel()

ilTestQuestionSideListGUI::buildPanel ( )

private

Returns: ilPanelGUI

Definition at line 159 of file class.ilTestQuestionSideListGUI.php.

References $panel, ilPanelGUI\getInstance(), ilPanelGUI\HEADING_STYLE_SUBHEADING, ILIAS\Repository\lng(), and ilPanelGUI\PANEL_STYLE_SECONDARY.

Referenced by getHTML().

                                  : ilPanelGUI
     {
         require_once 'Services/UIComponent/Panel/classes/class.ilPanelGUI.php';
         $panel = ilPanelGUI::getInstance();
         $panel->setHeadingStyle(ilPanelGUI::HEADING_STYLE_SUBHEADING);
         $panel->setPanelStyle(ilPanelGUI::PANEL_STYLE_SECONDARY);
         $panel->setHeading($this->lng->txt('list_of_questions'));
         return $panel;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCurrentPresentationMode()

ilTestQuestionSideListGUI::getCurrentPresentationMode ( )

Returns: string

Definition at line 127 of file class.ilTestQuestionSideListGUI.php.

References $currentPresentationMode.

Referenced by buildLink().

                                                 : string
     {
         return $this->currentPresentationMode;
     }

Here is the caller graph for this function:

◆ getCurrentSequenceElement()

ilTestQuestionSideListGUI::getCurrentSequenceElement ( )

Returns: int

Definition at line 111 of file class.ilTestQuestionSideListGUI.php.

References $currentSequenceElement.

Referenced by buildLink(), and renderList().

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

Here is the caller graph for this function:

◆ getHTML()

ilTestQuestionSideListGUI::getHTML ( )

Returns: string

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

References $panel, buildPanel(), and renderList().

                              : string
     {
         $panel = $this->buildPanel();
         $panel->setBody($this->renderList());
         return $panel->getHTML();
     }

Here is the call graph for this function:

◆ getQuestionSummaryData()

ilTestQuestionSideListGUI::getQuestionSummaryData ( )

Returns: array

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

References $questionSummaryData.

Referenced by renderList().

                                             : array
     {
         return $this->questionSummaryData;
     }

Here is the caller graph for this function:

◆ getTargetGUI()

ilTestQuestionSideListGUI::getTargetGUI ( )

Returns: ilTestPlayerAbstractGUI

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

References $targetGUI.

Referenced by buildLink().

                                   : ilTestPlayerAbstractGUI
     {
         return $this->targetGUI;
     }

Here is the caller graph for this function:

◆ isDisabled()

ilTestQuestionSideListGUI::isDisabled ( )

Returns: boolean

Definition at line 143 of file class.ilTestQuestionSideListGUI.php.

References $disabled.

Referenced by renderList().

                                 : bool
     {
         return $this->disabled;
     }

Here is the caller graph for this function:

◆ renderList()

ilTestQuestionSideListGUI::renderList ( )

private

Returns: string

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

References $tpl, buildLink(), getCurrentSequenceElement(), ilUtil\getImagePath(), getQuestionSummaryData(), isDisabled(), ILIAS\Repository\lng(), ilLegacyFormElementsUtil\prepareFormOutput(), and ilTestPlayerCommands\SHOW_QUESTION.

Referenced by getHTML().

                                  : string
     {
         $tpl = new ilTemplate('tpl.il_as_tst_list_of_questions_short.html', true, true, 'Modules/Test');
 
         foreach ($this->getQuestionSummaryData() as $row) {
             $title = ilLegacyFormElementsUtil::prepareFormOutput($row['title']);
 
             if (strlen($row['description'])) {
                 $description = " title=\"" . htmlspecialchars($row['description']) . "\" ";
             } else {
                 $description = "";
             }
 
             $active = ($row['sequence'] == $this->getCurrentSequenceElement()) ? ' active' : '';
 
             $class = (
                 $row['worked_through'] ? 'answered' . $active : 'unanswered' . $active
             );
 
             $headerclass = ($row['sequence'] == $this->getCurrentSequenceElement()) ? 'bold' : '';
 
             if ($row['marked']) {
                 $tpl->setCurrentBlock("mark_icon");
                 $tpl->setVariable("ICON_SRC", ilUtil::getImagePath('marked.svg'));
                 $tpl->setVariable("ICON_TEXT", $this->lng->txt('tst_question_marked'));
                 $tpl->setVariable("ICON_CLASS", 'ilTestMarkQuestionIcon');
                 $tpl->parseCurrentBlock();
             }
 
             if ($this->isDisabled() || $row['disabled']) {
                 $tpl->setCurrentBlock('disabled_entry');
                 $tpl->setVariable('CLASS', $class);
                 $tpl->setVariable('HEADERCLASS', $headerclass);
                 $tpl->setVariable('ITEM', $title);
                 $tpl->setVariable('DESCRIPTION', $description);
                 $tpl->parseCurrentBlock();
             } else {
                 // fau: testNav - show mark icon in side list
                 // fau.
                 $tpl->setCurrentBlock('linked_entry');
                 $tpl->setVariable('HREF', $this->buildLink($row['sequence']));
                 $tpl->setVariable('NEXTCMD', ilTestPlayerCommands::SHOW_QUESTION);
                 $tpl->setVariable('NEXTSEQ', $row['sequence']);
                 $tpl->setVariable('HEADERCLASS', $headerclass);
                 $tpl->setVariable('CLASS', $class);
                 $tpl->setVariable('ITEM', $title);
                 $tpl->setVariable("DESCRIPTION", $description);
                 $tpl->parseCurrentBlock();
             }
 
             $tpl->setCurrentBlock('item');
         }
 
         return $tpl->get();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCurrentPresentationMode()

ilTestQuestionSideListGUI::setCurrentPresentationMode ( $currentPresentationMode )

Parameters

string $currentPresentationMode

Definition at line 135 of file class.ilTestQuestionSideListGUI.php.

References $currentPresentationMode.

     {
         $this->currentPresentationMode = $currentPresentationMode;
     }

◆ setCurrentSequenceElement()

ilTestQuestionSideListGUI::setCurrentSequenceElement ( $currentSequenceElement )

Parameters

int $currentSequenceElement

Definition at line 119 of file class.ilTestQuestionSideListGUI.php.

References $currentSequenceElement.

     {
         $this->currentSequenceElement = $currentSequenceElement;
     }

◆ setDisabled()

ilTestQuestionSideListGUI::setDisabled ( $disabled )

Parameters

boolean $disabled

Definition at line 151 of file class.ilTestQuestionSideListGUI.php.

References $disabled, and ILIAS\UI\examples\Input\Field\Checkbox\disabled().

     {
         $this->disabled = $disabled;
     }

Here is the call graph for this function:

◆ setQuestionSummaryData()

ilTestQuestionSideListGUI::setQuestionSummaryData ( $questionSummaryData )

Parameters

array $questionSummaryData

Definition at line 103 of file class.ilTestQuestionSideListGUI.php.

References $questionSummaryData.

     {
         $this->questionSummaryData = $questionSummaryData;
     }

◆ setTargetGUI()

ilTestQuestionSideListGUI::setTargetGUI ( $targetGUI )

Parameters

ilTestPlayerAbstractGUI $targetGUI

Definition at line 87 of file class.ilTestQuestionSideListGUI.php.

References $targetGUI.

     {
         $this->targetGUI = $targetGUI;
     }

Field Documentation

◆ $ctrl

ilTestQuestionSideListGUI::$ctrl

protected

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

Referenced by __construct().

◆ $currentPresentationMode

ilTestQuestionSideListGUI::$currentPresentationMode

private

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

Referenced by getCurrentPresentationMode(), and setCurrentPresentationMode().

◆ $currentSequenceElement

ilTestQuestionSideListGUI::$currentSequenceElement

private

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

Referenced by getCurrentSequenceElement(), and setCurrentSequenceElement().

◆ $disabled

ilTestQuestionSideListGUI::$disabled

private

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

Referenced by isDisabled(), and setDisabled().

◆ $lng

ilTestQuestionSideListGUI::$lng

protected

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

Referenced by __construct().

◆ $questionSummaryData

ilTestQuestionSideListGUI::$questionSummaryData

private

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

Referenced by getQuestionSummaryData(), and setQuestionSummaryData().

◆ $targetGUI

ilTestQuestionSideListGUI::$targetGUI

private

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

Referenced by getTargetGUI(), and setTargetGUI().

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

Modules/Test/classes/class.ilTestQuestionSideListGUI.php

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildLink()

◆ buildPanel()

◆ getCurrentPresentationMode()

◆ getCurrentSequenceElement()

◆ getHTML()

◆ getQuestionSummaryData()

◆ getTargetGUI()

◆ isDisabled()

◆ renderList()

◆ setCurrentPresentationMode()

◆ setCurrentSequenceElement()

◆ setDisabled()

◆ setQuestionSummaryData()

◆ setTargetGUI()

Field Documentation

◆ $ctrl

◆ $currentPresentationMode

◆ $currentSequenceElement

◆ $disabled

◆ $lng

◆ $questionSummaryData

◆ $targetGUI