ILIAS\Test\Questions\Presentation\Printer Class Reference

Collaboration diagram for ILIAS\Test\Questions\Presentation\Printer:

Public Member Functions
	__construct (private readonly UIFactory $ui_factory, private \ilGlobalTemplateInterface $tpl, private TabsManager $tabs_manager, private \ilToolbarGUI $toolbar, private readonly Refinery $refinery, private readonly Language $lng, private readonly \ilCtrl $ctrl, private readonly \ilObjUser $user, private readonly \ilTestQuestionHeaderBlockBuilder $question_header_builder, private readonly \ilObjTest $test_obj,)
	printSelectedQuestions (array $print_view_types, ?Types $selected_print_view_type, array $question_ids)
	printAnswers (int $question_id)

Private Member Functions
	addQuestionResultForTestUsersToTemplate (\ilTemplate $template, \assQuestionGUI $question_gui, int $test_id)
	addResultUserInfoToTemplate (\ilTemplate $template, int $active_id, int $pass)
	addPrintButtonToToolbar ()

Detailed Description

Definition at line 29 of file Printer.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Test\Questions\Presentation\Printer::__construct	(	private readonly UIFactory	$ui_factory,
		private \ilGlobalTemplateInterface	$tpl,
		private TabsManager	$tabs_manager,
		private \ilToolbarGUI	$toolbar,
		private readonly Refinery	$refinery,
		private readonly Language	$lng,
		private readonly \ilCtrl	$ctrl,
		private readonly \ilObjUser	$user,
		private readonly \ilTestQuestionHeaderBlockBuilder	$question_header_builder,
		private readonly \ilObjTest	$test_obj
	)

Parameters

array

$data

<string, mixed>

Definition at line 34 of file Printer.php.

      {
    }

Member Function Documentation

addPrintButtonToToolbar()

ILIAS\Test\Questions\Presentation\Printer::addPrintButtonToToolbar ( )

private

Definition at line 230 of file Printer.php.

References $id, ILIAS\Repository\lng(), ILIAS\Repository\toolbar(), and ILIAS\UI\Implementation\Component\withOnLoadCode().

Referenced by ILIAS\Test\Questions\Presentation\Printer\printAnswers(), and ILIAS\Test\Questions\Presentation\Printer\printSelectedQuestions().

                                              : void
    {
        $this->toolbar->addComponent(
            $this->ui_factory->button()->standard($this->lng->txt('print'), '')
                ->withOnLoadCode(fn($id) => "$('#$id').on('click', ()=>{window.print();})")
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addQuestionResultForTestUsersToTemplate()

ILIAS\Test\Questions\Presentation\Printer::addQuestionResultForTestUsersToTemplate ( \ilTemplate  $template, \assQuestionGUI  $question_gui, int  $test_id  )

private

Definition at line 155 of file Printer.php.

References ilObjTest\_getResultPass(), ILIAS\Test\Questions\Presentation\Printer\addResultUserInfoToTemplate(), assQuestionGUI\getObject(), assQuestionGUI\getSolutionOutput(), null, ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

Referenced by ILIAS\Test\Questions\Presentation\Printer\printAnswers().

     : \ilTemplate {
        $this->test_obj->setAccessFilteredParticipantList(
            $this->test_obj->buildStatisticsAccessFilteredParticipantList()
        );

        $foundusers = $this->test_obj->getParticipantsForTestAndQuestion(
            $test_id,
            $question_gui->getObject()->getId()
        );

        foreach ($foundusers as $active_id => $passes) {
            if (($resultpass = \ilObjTest::_getResultPass($active_id)) === null) {
                continue;
            }

            for ($i = 0; $i < count($passes); $i++) {
                if ($passes[$i]['pass'] !== $resultpass) {
                    continue;
                }

                $template->setCurrentBlock('question');
                $template = $this->addResultUserInfoToTemplate(
                    $template,
                    $active_id,
                    $resultpass + 1
                );
                $template->setVariable(
                    'SOLUTION_OUTPUT',
                    $question_gui->getSolutionOutput(
                        $active_id,
                        $resultpass,
                        false,
                        false,
                        false,
                        false
                    )
                );
                $template->parseCurrentBlock('question');
            }
        }
        return $template;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addResultUserInfoToTemplate()

ILIAS\Test\Questions\Presentation\Printer::addResultUserInfoToTemplate ( \ilTemplate  $template, int  $active_id, int  $pass  )

private

Definition at line 202 of file Printer.php.

References $user_id, ilObjUser\_lookupLogin(), ILIAS\Repository\lng(), ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

Referenced by ILIAS\Test\Questions\Presentation\Printer\addQuestionResultForTestUsersToTemplate().

     : \ilTemplate {
        $user_id = $this->test_obj->_getUserIdFromActiveId($active_id);
        if (\ilObjUser::_lookupLogin($user_id) !== '') {
            $user = new \ilObjUser($user_id);
        } else {
            $user = new \ilObjUser();
            $user->setLastname($this->lng->txt('deleted_user'));
        }
        if ($user->getMatriculation() !== ''
            && $this->test_obj->getAnonymity() === false) {
            $template->setCurrentBlock('matriculation');
            $template->setVariable('TXT_USR_MATRIC', $this->lng->txt('matriculation'));
            $template->setVariable('VALUE_USR_MATRIC', $user->getMatriculation());
            $template->parseCurrentBlock();
        }

        $template->setVariable('TXT_USR_NAME', $this->lng->txt('name'));
        $uname = $this->test_obj->userLookupFullName($user_id, false);
        $template->setVariable('VALUE_USR_NAME', $uname);
        $template->setVariable('TXT_PASS', $this->lng->txt('scored_pass'));
        $template->setVariable('VALUE_PASS', $pass);
        return $template;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

printAnswers()

ILIAS\Test\Questions\Presentation\Printer::printAnswers

(

int

$question_id

)

Definition at line 123 of file Printer.php.

References ILIAS\Test\Questions\Presentation\Printer\addPrintButtonToToolbar(), ILIAS\Test\Questions\Presentation\Printer\addQuestionResultForTestUsersToTemplate(), ILIAS\Repository\ctrl(), ilUtil\getStyleSheetLocation(), ILIAS\Repository\lng(), assQuestionGUI\RENDER_PURPOSE_PREVIEW, ilObjTestGUI\SHOW_QUESTIONS_CMD, and ILIAS\Repository\user().

                                                  : void
    {
        $this->tabs_manager->resetTabsAndAddBacklink(
            $this->ctrl->getLinkTargetByClass(\ilObjTestGUI::class, \ilObjTestGUI::SHOW_QUESTIONS_CMD)
        );

        $this->addPrintButtonToToolbar();

        $template = new \ilTemplate('tpl.il_as_tst_print_questions_answers.html', true, true, 'components/ILIAS/Test');
        $this->tpl->addCss(\ilUtil::getStyleSheetLocation('output', 'test_print.css'), 'print');

        $question_gui = $this->test_obj->createQuestionGUI('', $question_id);
        $question_gui->setRenderPurpose(\assQuestionGUI::RENDER_PURPOSE_PREVIEW);
        $template->setVariable('TITLE', $question_gui->getObject()->getTitleForHTMLOutput());
        $template->setVariable('TXT_PRINT_DATE', $this->lng->txt('date'));
        $template->setVariable(
            'VALUE_PRINT_DATE',
            (new \DateTimeImmutable())
                ->setTimezone(new \DateTimeZone($this->user->getTimeZone()))
                ->format($this->user->getDateTimeFormat()->toString())
        );

        $this->tpl->setVariable(
            'PRINT_CONTENT',
            $this->addQuestionResultForTestUsersToTemplate(
                $template,
                $question_gui,
                $this->test_obj->getTestId()
            )->get()
        );
    }

Here is the call graph for this function:

printSelectedQuestions()

ILIAS\Test\Questions\Presentation\Printer::printSelectedQuestions	(	array	$print_view_types,
		?Types	$selected_print_view_type,
		array	$question_ids
	)

Parameters

array<int>

$question_ids

Definition at line 51 of file Printer.php.

References ILIAS\Test\Questions\Presentation\Printer\addPrintButtonToToolbar(), ILIAS\Repository\ctrl(), ilUtil\getStyleSheetLocation(), ILIAS\Repository\lng(), null, ILIAS\Repository\refinery(), assQuestionGUI\RENDER_PURPOSE_PREVIEW, ilObjTestGUI\SHOW_QUESTIONS_CMD, ILIAS\Repository\toolbar(), and ILIAS\Repository\user().

     : void {
        $this->tabs_manager->resetTabsAndAddBacklink(
            $this->ctrl->getLinkTargetByClass(\ilObjTestGUI::class, \ilObjTestGUI::SHOW_QUESTIONS_CMD)
        );

        $this->toolbar->addComponent(
            $this->ui_factory->viewControl()->mode(
                $print_view_types,
                $this->lng->txt('show_hide_best_solution')
            )->withActive($selected_print_view_type->getLabel($this->lng))
        );

        $this->toolbar->addSeparator();
        $this->addPrintButtonToToolbar();

        $template = new \ilTemplate('tpl.il_as_tst_print_questions_preview.html', true, true, 'components/ILIAS/Test');

        $this->tpl->addCss(\ilUtil::getStyleSheetLocation('output', 'test_print.css'), 'print');

        $max_points = 0;
        $counter = 1;
        $this->question_header_builder->setHeaderMode($this->test_obj->getTitleOutput());

        foreach ($question_ids as $question_id) {
            $template->setCurrentBlock('question');
            $question_gui = $this->test_obj->createQuestionGUI('', $question_id);
            $question_gui->setRenderPurpose(\assQuestionGUI::RENDER_PURPOSE_PREVIEW);

            $this->question_header_builder->setQuestionTitle($question_gui->getObject()->getTitleForHTMLOutput());
            $this->question_header_builder->setQuestionPoints($question_gui->getObject()->getMaximumPoints());
            $this->question_header_builder->setQuestionPosition($counter);
            $template->setVariable('QUESTION_HEADER', $this->question_header_builder->getHTML());

            if ($selected_print_view_type === Types::RESULTS_VIEW_TYPE_HIDE) {
                $template->setVariable('SOLUTION_OUTPUT', $question_gui->getPreview(false));
            } else {
                $template->setVariable('TXT_QUESTION_ID', $this->lng->txt('question_id_short'));
                $template->setVariable('QUESTION_ID', $question_gui->getObject()->getId());
                $template->setVariable('SOLUTION_OUTPUT', $question_gui->getSolutionOutput(0, null, false, true, false, false));
            }

            $template->parseCurrentBlock('question');
            $counter++;
            $max_points += $question_gui->getObject()->getMaximumPoints();
        }

        $template->setVariable(
            'TITLE',
            $this->refinery->encode()->htmlSpecialCharsAsEntities()->transform(
                $this->test_obj->getTitle()
            )
        );
        $template->setVariable('PRINT_TEST', $this->lng->txt('tst_print'));
        $template->setVariable('TXT_PRINT_DATE', $this->lng->txt('date'));
        $template->setVariable(
            'VALUE_PRINT_DATE',
            (new \DateTimeImmutable())
                ->setTimezone(new \DateTimeZone($this->user->getTimeZone()))
                ->format($this->user->getDateTimeFormat()->toString())
        );
        $template->setVariable(
            'TXT_MAXIMUM_POINTS',
            $this->lng->txt('tst_maximum_points')
        );
        $template->setVariable('VALUE_MAXIMUM_POINTS', $max_points);
        $this->tpl->setVariable('PRINT_CONTENT', $template->get());
    }

Here is the call graph for this function:

---

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

• components/ILIAS/Test/src/Questions/Presentation/Printer.php