ilTestQuestionSideListGUI Class Reference

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 11 of file class.ilTestQuestionSideListGUI.php.

Constructor & Destructor Documentation

__construct()

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

Parameters

ilCtrl	$ctrl
ilLanguage	$lng

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

References $ctrl, and $lng.

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

Member Function Documentation

buildLink()

ilTestQuestionSideListGUI::buildLink (   $sequenceElement )

private

Parameters

$row

Returns

string

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

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

Referenced by renderList().

    {
        $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 145 of file class.ilTestQuestionSideListGUI.php.

References ilPanelGUI\getInstance(), ilPanelGUI\HEADING_STYLE_SUBHEADING, and ilPanelGUI\PANEL_STYLE_SECONDARY.

Referenced by getHTML().

    {
        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 113 of file class.ilTestQuestionSideListGUI.php.

References $currentPresentationMode.

Referenced by buildLink().

    {
        return $this->currentPresentationMode;
    }

Here is the caller graph for this function:

getCurrentSequenceElement()

ilTestQuestionSideListGUI::getCurrentSequenceElement

(

)

Returns

int

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

References $currentSequenceElement.

Referenced by buildLink(), and renderList().

    {
        return $this->currentSequenceElement;
    }

Here is the caller graph for this function:

getHTML()

ilTestQuestionSideListGUI::getHTML

(

)

Returns

string

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

References buildPanel(), and renderList().

    {
        $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 81 of file class.ilTestQuestionSideListGUI.php.

References $questionSummaryData.

Referenced by renderList().

    {
        return $this->questionSummaryData;
    }

Here is the caller graph for this function:

getTargetGUI()

ilTestQuestionSideListGUI::getTargetGUI

(

)

Returns

ilTestPlayerAbstractGUI

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

References $targetGUI.

Referenced by buildLink().

    {
        return $this->targetGUI;
    }

Here is the caller graph for this function:

isDisabled()

ilTestQuestionSideListGUI::isDisabled

(

)

Returns

boolean

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

References $disabled.

Referenced by renderList().

    {
        return $this->disabled;
    }

Here is the caller graph for this function:

renderList()

ilTestQuestionSideListGUI::renderList ( )

private

Returns

string

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

References $description, $row, $title, $tpl, buildLink(), getCurrentSequenceElement(), ilUtil\getImagePath(), getQuestionSummaryData(), isDisabled(), ilUtil\prepareFormOutput(), and ilTestPlayerCommands\SHOW_QUESTION.

Referenced by getHTML().

    {
        $tpl = new ilTemplate('tpl.il_as_tst_list_of_questions_short.html', true, true, 'Modules/Test');

        foreach ($this->getQuestionSummaryData() as $row) {
            $title = ilUtil::prepareFormOutput($row['title']);

            if (strlen($row['description'])) {
                $description = " title=\"{$row['description']}\" ";
            } else {
                $description = "";
            }

            $active = ($row['sequence'] == $this->getCurrentSequenceElement()) ? ' active' : '';
            
            $class = (
                $row['worked_through'] ? 'answered' . $active : 'unanswered' . $active
            );
            
            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('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('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 121 of file class.ilTestQuestionSideListGUI.php.

References $currentPresentationMode.

    {
        $this->currentPresentationMode = $currentPresentationMode;
    }

setCurrentSequenceElement()

ilTestQuestionSideListGUI::setCurrentSequenceElement

(

$currentSequenceElement

)

Parameters

int

$currentSequenceElement

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

References $currentSequenceElement.

    {
        $this->currentSequenceElement = $currentSequenceElement;
    }

setDisabled()

ilTestQuestionSideListGUI::setDisabled

(

$disabled

)

Parameters

boolean

$disabled

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

References $disabled.

    {
        $this->disabled = $disabled;
    }

setQuestionSummaryData()

ilTestQuestionSideListGUI::setQuestionSummaryData

(

$questionSummaryData

)

Parameters

array

$questionSummaryData

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

References $questionSummaryData.

    {
        $this->questionSummaryData = $questionSummaryData;
    }

setTargetGUI()

ilTestQuestionSideListGUI::setTargetGUI

(

$targetGUI

)

Parameters

ilTestPlayerAbstractGUI

$targetGUI

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

References $targetGUI.

    {
        $this->targetGUI = $targetGUI;
    }

Field Documentation

$ctrl

ilTestQuestionSideListGUI::$ctrl

protected

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

Referenced by __construct().

$currentPresentationMode

ilTestQuestionSideListGUI::$currentPresentationMode

private

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

Referenced by getCurrentPresentationMode(), and setCurrentPresentationMode().

$currentSequenceElement

ilTestQuestionSideListGUI::$currentSequenceElement

private

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

Referenced by getCurrentSequenceElement(), and setCurrentSequenceElement().

$disabled

ilTestQuestionSideListGUI::$disabled

private

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

Referenced by isDisabled(), and setDisabled().

$lng

ilTestQuestionSideListGUI::$lng

protected

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

Referenced by __construct().

$questionSummaryData

ilTestQuestionSideListGUI::$questionSummaryData

private

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

Referenced by getQuestionSummaryData(), and setQuestionSummaryData().

$targetGUI

ilTestQuestionSideListGUI::$targetGUI

private

Definition at line 26 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