Inheritance diagram for ilAssLacLegendGUI:

Collaboration diagram for ilAssLacLegendGUI:

Public Member Functions
	__construct (ilLanguage $lng, ilTemplate $tpl)

	getQuestionOBJ ()

	setQuestionOBJ (iQuestionCondition $questionOBJ)

	isInitialVisibilityEnabled ()

	setInitialVisibilityEnabled ($initialVisibilityEnabled)

	getHTML ()

	getTriggerElement ()

	getExpressionTypeExamplesByQuestionType ($questionType)

Public Member Functions inherited from ilOverlayGUI
	__construct ($a_overlay_el_id)
	Constructor. More...

	setAnchor ($a_anchor_el_id, $a_ov_corner="tl", $a_anch_corner="bl")
	Set anchor element. More...

	setSize ($a_width="", $a_height="")
	Set size. More...

	setFixedCenter ($a_fixed_center=true)
	Set fixed center. More...

	setVisible ($a_visible=true)
	Set visible. More...

	setTrigger ($a_el_id, $a_event="click", $a_trigger_anchor_el_id=null)
	Set trigger element. More...

	setAutoHide ($a_val)
	Set auto hiding. More...

	getAutoHide ()
	Get auto_hide. More...

	setCloseElementId ($a_val)
	Set close element id. More...

	getCloseElementId ()
	Get close element id. More...

	getOnLoadCode ()
	Makes an existing HTML element an overlay. More...

	add ()
	Makes an existing HTML element an overlay. More...

	getTriggerOnLoadCode ( $a_tr_id, $a_tr_event, $a_anchor_el_id, $a_center=false, $a_ov_corner="tl", $a_anch_corner="bl")
	Get trigger onload code. More...

	addTrigger ( $a_tr_id, $a_tr_event, $a_anchor_el_id, $a_center=false, $a_ov_corner="tl", $a_anch_corner="bl")
	Add trigger. More...

Protected Member Functions
	renderCloseIcon ($tpl)

	initOverlay ()

	getTemplate ()

	renderCommonLegendPart (ilTemplate $tpl)

	renderQuestSpecificLegendPart (ilTemplate $tpl)

	renderQuestSpecificExamples (ilTemplate $tpl)

	buildLangVarsByExampleCode ($questionType, $exampleCode)

	renderExample (ilTemplate $tpl, $langVarE, $langVarD)

	populateVisibilityCss (ilTemplate $tpl)

	populateTriggerDepencies (ilTemplate $tpl)

	getQuestionTypeSpecificExpressions ()

	getCommonElements ()

	getAvailableExpressionTypes ()

	renderExamples (ilTemplate $tpl, $examples, $questionType)

Protected Attributes
	$lng

	$tpl

Protected Attributes inherited from ilOverlayGUI
	$tpl

	$width = ""

	$height = ""

	$fixed_center = false

	$visible = false

	$anchor_el_id = ""

	$anchor_ov_corner = ""

	$anchor_anch_corner = ""

	$auto_hide = false

	$close_el = null

Private Attributes
	$initialVisibilityEnabled

	$questionOBJ

	$examplesByQuestionType

Additional Inherited Members
Static Public Member Functions inherited from ilOverlayGUI
static	initJavascript ()
	Init javascript. More...

Detailed Description

Definition at line 13 of file class.ilAssLacLegendGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilAssLacLegendGUI::__construct	(	ilLanguage	$lng,
		ilTemplate	$tpl
	)

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

References $lng, and $tpl.

     {
         $this->lng = $lng;
         $this->tpl = $tpl;
         
         $this->initialVisibilityEnabled = false;
 
         $this->questionOBJ = null;
 
         parent::__construct('qpl_lac_legend');
     }

Member Function Documentation

◆ buildLangVarsByExampleCode()

ilAssLacLegendGUI::buildLangVarsByExampleCode	(	$questionType,
		$exampleCode
	)

protected

Definition at line 177 of file class.ilAssLacLegendGUI.php.

Referenced by renderExamples().

     {
         $langVar = 'lacex_' . $questionType . '_' . $exampleCode;
         return array($langVar . '_e', $langVar . '_d');
     }

Here is the caller graph for this function:

◆ getAvailableExpressionTypes()

ilAssLacLegendGUI::getAvailableExpressionTypes ( )

protected

Definition at line 255 of file class.ilAssLacLegendGUI.php.

References iQuestionCondition\EmptyAnswerExpression, iQuestionCondition\ExclusiveResultExpression, iQuestionCondition\MatchingResultExpression, iQuestionCondition\NumberOfResultExpression, iQuestionCondition\NumericResultExpression, iQuestionCondition\OrderingResultExpression, iQuestionCondition\PercentageResultExpression, and iQuestionCondition\StringResultExpression.

Referenced by getQuestionTypeSpecificExpressions().

     {
         return array(
             iQuestionCondition::PercentageResultExpression => 'qpl_lac_desc_compare_with_quest_res',
             iQuestionCondition::NumericResultExpression => 'qpl_lac_desc_compare_with_number',
             iQuestionCondition::StringResultExpression => 'qpl_lac_desc_compare_with_text',
             iQuestionCondition::MatchingResultExpression => 'qpl_lac_desc_compare_with_assignment',
             iQuestionCondition::OrderingResultExpression => 'qpl_lac_desc_compare_with_sequence',
             iQuestionCondition::NumberOfResultExpression => 'qpl_lac_desc_compare_with_answer_n',
             iQuestionCondition::ExclusiveResultExpression => 'qpl_lac_desc_compare_with_exact_sequence',
             iQuestionCondition::EmptyAnswerExpression => 'qpl_lac_desc_compare_answer_exist'
         );
     }

Here is the caller graph for this function:

◆ getCommonElements()

ilAssLacLegendGUI::getCommonElements ( )

protected

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

Referenced by renderCommonLegendPart().

     {
         return array(
             '&' => $this->lng->txt('qpl_lac_desc_logical_and'),
             '|' => $this->lng->txt('qpl_lac_desc_logical_or'),
             '!' => $this->lng->txt('qpl_lac_desc_negation'),
             '()' => $this->lng->txt('qpl_lac_desc_brackets'),
             //'Qn' => $this->lng->txt('qpl_lac_desc_res_of_quest_n'),
             //'Qn[m]' => $this->lng->txt('qpl_lac_desc_res_of_answ_m_of_quest_n'),
             'R' => $this->lng->txt('qpl_lac_desc_res_of_cur_quest'),
             'R[m]' => $this->lng->txt('qpl_lac_desc_res_of_answ_m_of_cur_quest')
         );
     }

Here is the caller graph for this function:

◆ getExpressionTypeExamplesByQuestionType()

ilAssLacLegendGUI::getExpressionTypeExamplesByQuestionType ( $questionType )

Definition at line 269 of file class.ilAssLacLegendGUI.php.

Referenced by renderQuestSpecificExamples().

     {
         if (!isset($this->examplesByQuestionType[$questionType])) {
             return array();
         }
         
         return $this->examplesByQuestionType[$questionType];
     }

Here is the caller graph for this function:

◆ getHTML()

ilAssLacLegendGUI::getHTML ( )

Definition at line 77 of file class.ilAssLacLegendGUI.php.

References $tpl, getTemplate(), initOverlay(), populateTriggerDepencies(), populateVisibilityCss(), renderCloseIcon(), renderCommonLegendPart(), renderQuestSpecificExamples(), and renderQuestSpecificLegendPart().

     {
         $this->initOverlay();
 
         $tpl = $this->getTemplate();
         
         $this->renderCloseIcon($tpl);
         $this->renderCommonLegendPart($tpl);
         $this->renderQuestSpecificLegendPart($tpl);
         $this->renderQuestSpecificExamples($tpl);
         
         $this->populateVisibilityCss($tpl);
         $this->populateTriggerDepencies($tpl);
         
         return $tpl->get();
     }

Here is the call graph for this function:

◆ getQuestionOBJ()

ilAssLacLegendGUI::getQuestionOBJ ( )

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

References $questionOBJ.

Referenced by getQuestionTypeSpecificExpressions(), renderQuestSpecificExamples(), and renderQuestSpecificLegendPart().

     {
         return $this->questionOBJ;
     }

Here is the caller graph for this function:

◆ getQuestionTypeSpecificExpressions()

ilAssLacLegendGUI::getQuestionTypeSpecificExpressions ( )

protected

Definition at line 228 of file class.ilAssLacLegendGUI.php.

References getAvailableExpressionTypes(), and getQuestionOBJ().

Referenced by renderQuestSpecificLegendPart().

     {
         $availableExpressionTypes = $this->getAvailableExpressionTypes();
 
         $expressionTypes = array();
 
         foreach ($this->getQuestionOBJ()->getExpressionTypes() as $expressionType) {
             $expressionTypes[$expressionType] = $availableExpressionTypes[$expressionType];
         }
 
         return $expressionTypes;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTemplate()

ilAssLacLegendGUI::getTemplate ( )

protected

Definition at line 118 of file class.ilAssLacLegendGUI.php.

Referenced by getHTML().

     {
         return new ilTemplate(
             'tpl.qpl_logical_answer_compare_legend.html',
             true,
             true,
             'Modules/TestQuestionPool'
         );
     }

Here is the caller graph for this function:

◆ getTriggerElement()

ilAssLacLegendGUI::getTriggerElement ( )

Definition at line 223 of file class.ilAssLacLegendGUI.php.

     {
         return "<div id=\"qpl_lac_legend_trigger\"><a href=\"#\">" . $this->lng->txt("qpl_lac_legend_link") . "</a></div>";
     }

◆ initOverlay()

ilAssLacLegendGUI::initOverlay ( )

protected

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

References ilOverlayGUI\add(), ilYuiUtil\initOverlay(), isInitialVisibilityEnabled(), ilOverlayGUI\setAutoHide(), and ilOverlayGUI\setVisible().

Referenced by getHTML().

     {
         include_once 'Services/YUI/classes/class.ilYuiUtil.php';
         ilYuiUtil::initOverlay();
 
         $this->tpl->addCss('Modules/TestQuestionPool/templates/default/lac_legend.css');
         
         //$this->setAnchor('fixed_content', 'tr', 'tr');
         // we use css instead, does not hoppel over screen for initially visible overlays
 
         //$this->setTrigger('lac_legend_toggle_btn', 'click');
         // is done by own listener that also changes the toggle label
         
         $this->setVisible($this->isInitialVisibilityEnabled());
         $this->setAutoHide(false);
 
         $this->add();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isInitialVisibilityEnabled()

ilAssLacLegendGUI::isInitialVisibilityEnabled ( )

Definition at line 67 of file class.ilAssLacLegendGUI.php.

References $initialVisibilityEnabled.

Referenced by initOverlay(), and populateVisibilityCss().

     {
         return $this->initialVisibilityEnabled;
     }

Here is the caller graph for this function:

◆ populateTriggerDepencies()

ilAssLacLegendGUI::populateTriggerDepencies ( ilTemplate $tpl )

protected

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

References ilAssQuestionSkillAssignment\EVAL_MODE_BY_QUESTION_RESULT, ilAssQuestionSkillAssignment\EVAL_MODE_BY_QUESTION_SOLUTION, and HTML_Template_IT\setVariable().

Referenced by getHTML().

     {
         require_once 'Modules/TestQuestionPool/classes/class.ilAssQuestionSkillAssignment.php';
 
         $tpl->setVariable(
             'TOGGLE_BTN_SHOW_LABEL',
             $this->lng->txt('ass_lac_show_legend_btn')
         );
         
         $tpl->setVariable(
             'TOGGLE_BTN_HIDE_LABEL',
             $this->lng->txt('ass_lac_hide_legend_btn')
         );
         
         $tpl->setVariable(
             'SKILL_POINT_EVAL_MODE_BY_RESULT',
             ilAssQuestionSkillAssignment::EVAL_MODE_BY_QUESTION_RESULT
         );
         
         $tpl->setVariable(
             'SKILL_POINT_EVAL_MODE_BY_SOLUTION',
             ilAssQuestionSkillAssignment::EVAL_MODE_BY_QUESTION_SOLUTION
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ populateVisibilityCss()

ilAssLacLegendGUI::populateVisibilityCss ( ilTemplate $tpl )

protected

Definition at line 191 of file class.ilAssLacLegendGUI.php.

References isInitialVisibilityEnabled(), and HTML_Template_IT\setVariable().

Referenced by getHTML().

     {
         if (!$this->isInitialVisibilityEnabled()) {
             $tpl->setVariable('CSS_DISPLAY_NONE', 'display:none;');
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderCloseIcon()

ilAssLacLegendGUI::renderCloseIcon ( $tpl )

protected

Definition at line 94 of file class.ilAssLacLegendGUI.php.

References $tpl, ilGlyphGUI\CLOSE, and ilGlyphGUI\get().

Referenced by getHTML().

     {
         $tpl->setVariable('CLOSE_ICON', ilGlyphGUI::get(ilGlyphGUI::CLOSE));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderCommonLegendPart()

ilAssLacLegendGUI::renderCommonLegendPart ( ilTemplate $tpl )

protected

Definition at line 128 of file class.ilAssLacLegendGUI.php.

References $description, getCommonElements(), ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

Referenced by getHTML().

     {
         $tpl->setVariable(
             'COMMON_ELEMENTS_HEADER',
             $this->lng->txt('qpl_lac_legend_header_common')
         );
 
         foreach ($this->getCommonElements() as $element => $description) {
             $tpl->setCurrentBlock('common_elements');
             $tpl->setVariable('CE_ELEMENT', $element);
             $tpl->setVariable('CE_DESCRIPTION', $description);
             $tpl->parseCurrentBlock();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderExample()

ilAssLacLegendGUI::renderExample	(	ilTemplate	$tpl,
			$langVarE,
			$langVarD
	)

protected

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

References ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

Referenced by renderExamples().

     {
         $tpl->setCurrentBlock('quest_specific_examples');
         $tpl->setVariable('QSEX_ELEMENT', $this->lng->txt($langVarE));
         $tpl->setVariable('QSEX_DESCRIPTION', $this->lng->txt($langVarD));
         $tpl->parseCurrentBlock();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderExamples()

ilAssLacLegendGUI::renderExamples	(	ilTemplate	$tpl,
			$examples,
			$questionType
	)

protected

Parameters

ilTemplate	$tpl
	$examples
	$questionType

Definition at line 283 of file class.ilAssLacLegendGUI.php.

References buildLangVarsByExampleCode(), and renderExample().

Referenced by renderQuestSpecificExamples().

     {
         foreach ($examples as $exampleCode) {
             list($langVarE, $langVarD) = $this->buildLangVarsByExampleCode($questionType, $exampleCode);
             $this->renderExample($tpl, $langVarE, $langVarD);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderQuestSpecificExamples()

ilAssLacLegendGUI::renderQuestSpecificExamples ( ilTemplate $tpl )

protected

Definition at line 160 of file class.ilAssLacLegendGUI.php.

References getExpressionTypeExamplesByQuestionType(), getQuestionOBJ(), renderExamples(), and HTML_Template_IT\setVariable().

Referenced by getHTML().

     {
         $tpl->setVariable(
             'QUEST_SPECIFIC_EXAMPLES_HEADER',
             $this->lng->txt('lacex_example_header')
         );
 
         $questionTypes = array(
             'assQuestion', $this->getQuestionOBJ()->getQuestionType()
         );
         
         foreach ($questionTypes as $questionType) {
             $examples = $this->getExpressionTypeExamplesByQuestionType($questionType);
             $this->renderExamples($tpl, $examples, $questionType);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderQuestSpecificLegendPart()

ilAssLacLegendGUI::renderQuestSpecificLegendPart ( ilTemplate $tpl )

protected

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

References $description, getQuestionOBJ(), getQuestionTypeSpecificExpressions(), ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

Referenced by getHTML().

     {
         $tpl->setVariable(
             'QUEST_SPECIFIC_ELEMENTS_HEADER',
             $this->lng->txt('qpl_lac_legend_header_quest_specific')
         );
         
         foreach ($this->getQuestionTypeSpecificExpressions() as $expression => $description) {
             $tpl->setCurrentBlock('quest_specific_elements');
             $tpl->setVariable('QSE_ELEMENT', $expression);
             $tpl->setVariable('QSE_DESCRIPTION', $this->lng->txt($description));
             $tpl->setVariable('QSE_OPERATORS_TXT', $this->lng->txt('qpl_lac_legend_label_operators'));
             $tpl->setVariable('QSE_OPERATORS', implode(', ', $this->getQuestionOBJ()->getOperators($expression)));
             $tpl->parseCurrentBlock();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setInitialVisibilityEnabled()

ilAssLacLegendGUI::setInitialVisibilityEnabled ( $initialVisibilityEnabled )

Definition at line 72 of file class.ilAssLacLegendGUI.php.

References $initialVisibilityEnabled.

     {
         $this->initialVisibilityEnabled = $initialVisibilityEnabled;
     }

◆ setQuestionOBJ()

ilAssLacLegendGUI::setQuestionOBJ ( iQuestionCondition $questionOBJ )

Definition at line 62 of file class.ilAssLacLegendGUI.php.

References $questionOBJ.

     {
         $this->questionOBJ = $questionOBJ;
     }

Field Documentation

◆ $examplesByQuestionType

ilAssLacLegendGUI::$examplesByQuestionType

private

Initial value:

= array(
        'assQuestion' => array('PercentageResultExpression', 'EmptyAnswerExpression'),
        'assSingleChoice' => array('NumberOfResultExpression'),
        'assMultipleChoice' => array('NumberOfResultExpression', 'ExclusiveResultExpression'),
        'assErrorText' => array('NumberOfResultExpression', 'ExclusiveResultExpression'),
        'assImagemapQuestion' => array('NumberOfResultExpression', 'ExclusiveResultExpression'),
        'assNumeric' => array('NumericResultExpression'),
        'assOrderingQuestion' => array('OrderingResultExpression'),
        'assOrderingHorizontal' => array('OrderingResultExpression'),
        'assMatchingQuestion' => array('MatchingResultExpression'),
        'assTextSubset' => array('StringResultExpression'),
        'assFormulaQuestion' => array('NumericResultExpression'),
        
        'assClozeTest' => array(
            'StringResultExpression_1', 'StringResultExpression_2',
            'NumberOfResultExpression', 'NumericResultExpression'
        ),
    )

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

◆ $initialVisibilityEnabled

ilAssLacLegendGUI::$initialVisibilityEnabled

private

Definition at line 19 of file class.ilAssLacLegendGUI.php.

Referenced by isInitialVisibilityEnabled(), and setInitialVisibilityEnabled().

◆ $lng

ilAssLacLegendGUI::$lng

protected

Definition at line 15 of file class.ilAssLacLegendGUI.php.

Referenced by __construct().

◆ $questionOBJ

ilAssLacLegendGUI::$questionOBJ

private

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

Referenced by getQuestionOBJ(), and setQuestionOBJ().

◆ $tpl

ilAssLacLegendGUI::$tpl

protected

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

Referenced by __construct(), getHTML(), and renderCloseIcon().

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

Modules/TestQuestionPool/classes/questions/LogicalAnswerCompare/class.ilAssLacLegendGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildLangVarsByExampleCode()

◆ getAvailableExpressionTypes()

◆ getCommonElements()

◆ getExpressionTypeExamplesByQuestionType()

◆ getHTML()

◆ getQuestionOBJ()

◆ getQuestionTypeSpecificExpressions()

◆ getTemplate()

◆ getTriggerElement()

◆ initOverlay()

◆ isInitialVisibilityEnabled()

◆ populateTriggerDepencies()

◆ populateVisibilityCss()

◆ renderCloseIcon()

◆ renderCommonLegendPart()

◆ renderExample()

◆ renderExamples()

◆ renderQuestSpecificExamples()

◆ renderQuestSpecificLegendPart()

◆ setInitialVisibilityEnabled()

◆ setQuestionOBJ()

Field Documentation

◆ $examplesByQuestionType

◆ $initialVisibilityEnabled

◆ $lng

◆ $questionOBJ

◆ $tpl