ilAssLacLegendGUI Class Reference

Collaboration diagram for ilAssLacLegendGUI:

Public Member Functions
	__construct (ilGlobalTemplateInterface $pageTemplate, ilLanguage $lng, \ILIAS\UI\Factory $uiFactory)
	ilAssLacLegendGUI constructor. More...
	getQuestionOBJ ()
	setQuestionOBJ (iQuestionCondition $questionOBJ)
	get ()

Protected Member Functions
	getTemplate ()

Protected Attributes
	$lng
	$pageTemplate

Private Member Functions
	renderCommonLegendPart (ilTemplate $tpl)
	renderQuestSpecificLegendPart (ilTemplate $tpl)
	renderQuestSpecificExamples (ilTemplate $tpl)
	buildLangVarsByExampleCode (string $questionType, string $exampleCode)
	renderExample (ilTemplate $tpl, string $langVarE, string $langVarD)
	getQuestionTypeSpecificExpressions ()
	getCommonElements ()
	getAvailableExpressionTypes ()
	getExpressionTypeExamplesByQuestionType (string $questionType)
	renderExamples (ilTemplate $tpl, array $examples, string $questionType)

Private Attributes
	$questionOBJ
	$examplesByQuestionType
	$uiFactory

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilAssLacLegendGUI::__construct	(	ilGlobalTemplateInterface	$pageTemplate,
		ilLanguage	$lng,
		\ILIAS\UI\Factory	$uiFactory
	)

ilAssLacLegendGUI constructor.

Parameters

ilGlobalTemplateInterface	$pageTemplate
ilLanguage	$lng
\ILIAS\UI\Factory	$uiFactory

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

References $lng, $pageTemplate, and $uiFactory.

      {
        $this->pageTemplate = $pageTemplate;
        $this->lng = $lng;
        $this->uiFactory = $uiFactory;
        $this->questionOBJ = null;
    }

Member Function Documentation

buildLangVarsByExampleCode()

ilAssLacLegendGUI::buildLangVarsByExampleCode ( string  $questionType, string  $exampleCode  )

private

Parameters

string	$questionType
string	$exampleCode

Returns

string[]

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

Referenced by renderExamples().

                                                                                           : array
    {
        $langVar = 'lacex_' . $questionType . '_' . $exampleCode;

        return [$langVar . '_e', $langVar . '_d'];
    }

Here is the caller graph for this function:

get()

ilAssLacLegendGUI::get

(

)

Returns

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

References $tpl, getTemplate(), renderCommonLegendPart(), renderQuestSpecificExamples(), and renderQuestSpecificLegendPart().

                          : \ILIAS\UI\Component\Modal\Modal
    {
        $this->pageTemplate->addCss('Modules/TestQuestionPool/templates/default/lac_legend.css');

        $tpl = $this->getTemplate();

        $this->renderCommonLegendPart($tpl);
        $this->renderQuestSpecificLegendPart($tpl);
        $this->renderQuestSpecificExamples($tpl);

        return $this->uiFactory->modal()->lightbox([
            $this->uiFactory->modal()->lightboxTextPage(
                $tpl->get(),
                $this->lng->txt('qpl_skill_point_eval_by_solution_compare')
            ),
        ]);
    }

Here is the call graph for this function:

getAvailableExpressionTypes()

ilAssLacLegendGUI::getAvailableExpressionTypes ( )

private

Returns

array<string, string>

Definition at line 224 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().

                                                   : array
    {
        return [
            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 ( )

private

Returns

array<string, string>

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

Referenced by renderCommonLegendPart().

    {
        return [
            '&' => $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 ( string  $questionType )

private

Parameters

string$questionType

Returns

string[]

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

Referenced by renderQuestSpecificExamples().

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

Here is the caller graph for this function:

getQuestionOBJ()

ilAssLacLegendGUI::getQuestionOBJ

(

)

Returns

iQuestionCondition|null

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

References $questionOBJ.

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

                                     : ? iQuestionCondition
    {
        return $this->questionOBJ;
    }

Here is the caller graph for this function:

getQuestionTypeSpecificExpressions()

ilAssLacLegendGUI::getQuestionTypeSpecificExpressions ( )

private

Returns

array<string, string>

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

References getAvailableExpressionTypes(), and getQuestionOBJ().

Referenced by renderQuestSpecificLegendPart().

                                                          : array
    {
        $availableExpressionTypes = $this->getAvailableExpressionTypes();

        $expressionTypes = [];

        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

Returns

ilTemplate

Exceptions

ilTemplateException

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

Referenced by get().

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

Here is the caller graph for this function:

renderCommonLegendPart()

ilAssLacLegendGUI::renderCommonLegendPart ( ilTemplate  $tpl )

private

Parameters

ilTemplate

$tpl

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

References getCommonElements(), ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), and ilGlobalTemplateInterface\setVariable().

Referenced by get().

                                                             : void
    {
        $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, string  $langVarE, string  $langVarD  )

private

Parameters

ilTemplate	$tpl
string	$langVarE
string	$langVarD

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

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

Referenced by renderExamples().

                                                                                        : void
    {
        $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, array  $examples, string  $questionType  )

private

Parameters

ilTemplate	$tpl
	string[]	$examples
string	$questionType

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

References buildLangVarsByExampleCode(), and renderExample().

Referenced by renderQuestSpecificExamples().

                                                                                            : void
    {
        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 )

private

Parameters

ilTemplate

$tpl

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

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

Referenced by get().

                                                                  : void
    {
        $tpl->setVariable(
            'QUEST_SPECIFIC_EXAMPLES_HEADER',
            $this->lng->txt('lacex_example_header')
        );

        $questionTypes = [
            '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 )

private

Parameters

ilTemplate

$tpl

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

References getQuestionOBJ(), getQuestionTypeSpecificExpressions(), ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), and ilGlobalTemplateInterface\setVariable().

Referenced by get().

                                                                    : void
    {
        $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:

setQuestionOBJ()

ilAssLacLegendGUI::setQuestionOBJ

(

iQuestionCondition

$questionOBJ

)

Parameters

iQuestionCondition

$questionOBJ

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

References $questionOBJ.

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

Field Documentation

$examplesByQuestionType

ilAssLacLegendGUI::$examplesByQuestionType

private

Initial value:

= [
        'assQuestion' => ['PercentageResultExpression', 'EmptyAnswerExpression']

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

$lng

ilAssLacLegendGUI::$lng

protected

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

Referenced by __construct().

$pageTemplate

ilAssLacLegendGUI::$pageTemplate

protected

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

Referenced by __construct().

$questionOBJ

ilAssLacLegendGUI::$questionOBJ

private

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

Referenced by getQuestionOBJ(), and setQuestionOBJ().

$uiFactory

ilAssLacLegendGUI::$uiFactory

private

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

Referenced by __construct().

---

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

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