class.ilParticipantsTestResultsGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\UI\Factory as UIFactory;
use ILIAS\UI\Renderer as UIRenderer;
use ILIAS\Test\InternalRequestService;

class ilParticipantsTestResultsGUI
{
    public const CMD_SHOW_PARTICIPANTS = 'showParticipants';
    public const CMD_CONFIRM_DELETE_ALL_USER_RESULTS = 'deleteAllUserResults';
    public const CMD_PERFORM_DELETE_ALL_USER_RESULTS = 'confirmDeleteAllUserResults';
    public const CMD_CONFIRM_DELETE_SELECTED_USER_RESULTS = 'deleteSingleUserResults';
    public const CMD_PERFORM_DELETE_SELECTED_USER_RESULTS = 'confirmDeleteSelectedUserData';

    private ?ilObjTest $test_obj = null;
    private ?ilTestQuestionSetConfig $question_set_config = null;
    private ?ilTestAccess $test_access = null;
    private ?ilTestObjectiveOrientedContainer $objective_parent = null;


    public function __construct(
        private ilCtrlInterface $ctrl,
        private ilLanguage $lng,
        private ilDBInterface $db,
        private ilObjUser $user,
        private ilTabsGUI $tabs,
        private ilToolbarGUI $toolbar,
        private ilGlobalTemplateInterface $main_tpl,
        private UIFactory $ui_factory,
        private UIRenderer $ui_renderer,
        private ilTestParticipantAccessFilterFactory $participant_access_filter_factory,
        private InternalRequestService $testrequest,
        private \ILIAS\HTTP\GlobalHttpState $http,
        private \ILIAS\Refinery\Factory $refinery,
    ) {
    }

    public function getObject(): ?ilObjTest
    {
        return $this->test_obj;
    }

    public function getTestObj(): ?ilObjTest
    {
        return $this->test_obj;
    }

    public function setTestObj(ilObjTest $test_obj): void
    {
        $this->test_obj = $test_obj;
    }

    public function getQuestionSetConfig(): ?ilTestQuestionSetConfig
    {
        return $this->question_set_config;
    }

    public function setQuestionSetConfig(ilTestQuestionSetConfig $question_set_config): void
    {
        $this->question_set_config = $question_set_config;
    }

    public function getTestAccess(): ?ilTestAccess
    {
        return $this->test_access;
    }

    public function setTestAccess(ilTestAccess $test_access): void
    {
        $this->test_access = $test_access;
    }

    public function getObjectiveParent(): ?ilTestObjectiveOrientedContainer
    {
        return $this->objective_parent;
    }

    public function setObjectiveParent(ilTestObjectiveOrientedContainer $objective_parent): void
    {
        $this->objective_parent = $objective_parent;
    }

    public function executeCommand(): void
    {
        switch ($this->ctrl->getNextClass($this)) {
            case "iltestevaluationgui":
                $this->forwardToEvaluationGUI();
                break;

            case 'ilassquestionpagegui':
                $forwarder = new ilAssQuestionPageCommandForwarder();
                $forwarder->setTestObj($this->getTestObj());
                $forwarder->forward();
                break;

            default:

                $command = $this->ctrl->getCmd(self::CMD_SHOW_PARTICIPANTS) . 'Cmd';
                $this->{$command}();
        }
    }
    private function getUserIdsFromPost(): array
    {
        return $this->http->wrapper()->post()->retrieve(
            'chbUser',
            $this->refinery->byTrying([
                $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int()),
                $this->refinery->always([])
            ])
        );
    }

    private function forwardToEvaluationGUI(): void
    {
        $gui = new ilTestEvaluationGUI($this->getTestObj());
        $gui->setObjectiveOrientedContainer($this->getObjectiveParent());
        $gui->setTestAccess($this->getTestAccess());
        $this->tabs->clearTargets();
        $this->tabs->clearSubTabs();
        $this->ctrl->forwardCommand($gui);
    }

    private function buildTableGUI(): ilParticipantsTestResultsTableGUI
    {
        $table_gui = new ilParticipantsTestResultsTableGUI(
            $this,
            self::CMD_SHOW_PARTICIPANTS,
            $this->ui_factory,
            $this->ui_renderer
        );
        $table_gui->setTitle($this->lng->txt('tst_tbl_results_grades'));
        return $table_gui;
    }

    private function showParticipantsCmd(): void
    {
        ilSession::clear("show_user_results");

        if ($this->getQuestionSetConfig()->areDepenciesBroken()) {
            $this->main_tpl->setOnScreenMessage(
                'failure',
                $this->getQuestionSetConfig()->getDepenciesBrokenMessage($this->lng)
            );
        } elseif ($this->getQuestionSetConfig()->areDepenciesInVulnerableState()) {
            $this->main_tpl->setOnScreenMessage(
                'info',
                $this->getQuestionSetConfig()->getDepenciesInVulnerableStateMessage($this->lng)
            );
        }

        $manage_participant_filter = $this->participant_access_filter_factory->getManageParticipantsUserFilter(
            $this->getTestObj()->getRefId()
        );
        $access_results_filter = $this->participant_access_filter_factory->getAccessResultsUserFilter(
            $this->getTestObj()->getRefId()
        );

        $full_participant_list = $this->getTestObj()->getActiveParticipantList();
        $participantList = $full_participant_list->getAccessFilteredList($manage_participant_filter);
        $access_to_results_participants = $full_participant_list->getAccessFilteredList($access_results_filter);
        foreach ($access_to_results_participants as $participant) {
            if (!$participantList->isActiveIdInList($participant->getActiveId())) {
                $participantList->addParticipant($participant);
            }
        }

        $scored_participant_list = $participantList->getScoredParticipantList();

        $table_gui = $this->buildTableGUI();

        if (!$this->getQuestionSetConfig()->areDepenciesBroken()) {
            $table_gui->setAccessResultsCommandsEnabled(
                $this->getTestAccess()->checkParticipantsResultsAccess()
            );

            $table_gui->setManageResultsCommandsEnabled(
                $this->getTestAccess()->checkManageParticipantsAccess()
            );

            if ($this->test_access->checkManageParticipantsAccess()
                && $scored_participant_list->hasScorings()) {
                $this->addDeleteAllTestResultsButton($this->toolbar);
            }
        }

        $table_gui->setAnonymity($this->getTestObj()->getMainSettings()->getGeneralSettings()->getAnonymity());

        $table_gui->initColumns();
        $table_gui->initCommands();

        $table_gui->setData($participantList->getScoringsTableRows());

        $this->main_tpl->setContent($table_gui->getHTML());
    }

    private function addDeleteAllTestResultsButton(ilToolbarGUI $toolbar): void
    {
        $delete_all_results_btn = $this->ui_factory->button()->standard($this->lng->txt('delete_all_user_data'), $this->ctrl->getLinkTarget($this, 'deleteAllUserResults'));
        $toolbar->addComponent($delete_all_results_btn);
    }

    private function deleteAllUserResultsCmd(): void
    {
        $cgui = new ilConfirmationGUI();
        $cgui->setFormAction($this->ctrl->getFormAction($this));
        $cgui->setHeaderText($this->lng->txt("delete_all_user_data_confirmation"));
        $cgui->setCancel($this->lng->txt("cancel"), self::CMD_SHOW_PARTICIPANTS);
        $cgui->setConfirm($this->lng->txt("proceed"), self::CMD_PERFORM_DELETE_ALL_USER_RESULTS);

        $this->main_tpl->setContent($cgui->getHTML());
    }

    private function confirmDeleteAllUserResultsCmd(): void
    {
        $access_filter = $this->participant_access_filter_factory->getManageParticipantsUserFilter(
            $this->getTestObj()->getRefId()
        );

        $participant_data = new ilTestParticipantData($this->db, $this->lng);
        $participant_data->setParticipantAccessFilter($access_filter);
        $participant_data->load($this->getTestObj()->getTestId());

        $this->getTestObj()->removeTestResults($participant_data);

        $this->main_tpl->setOnScreenMessage('success', $this->lng->txt("tst_all_user_data_deleted"), true);
        $this->ctrl->redirect($this, self::CMD_SHOW_PARTICIPANTS);
    }

    private function deleteSingleUserResultsCmd(): void
    {
        $usr_ids = $this->getUserIdsFromPost();
        if ($usr_ids === []) {
            $this->main_tpl->setOnScreenMessage('info', $this->lng->txt("select_one_user"), true);
            $this->ctrl->redirect($this);
        }

        $cgui = new ilConfirmationGUI();
        $cgui->setHeaderText($this->lng->txt("confirm_delete_single_user_data"));

        $cgui->setFormAction($this->ctrl->getFormAction($this));
        $cgui->setCancel($this->lng->txt("cancel"), self::CMD_SHOW_PARTICIPANTS);
        $cgui->setConfirm($this->lng->txt("confirm"), self::CMD_PERFORM_DELETE_SELECTED_USER_RESULTS);

        $access_filter = $this->participant_access_filter_factory->getManageParticipantsUserFilter($this->getTestObj()->getRefId());

        $participant_data = new ilTestParticipantData($this->db, $this->lng);
        $participant_data->setParticipantAccessFilter($access_filter);

        $participant_data->setActiveIdsFilter($usr_ids);

        $participant_data->load($this->getTestObj()->getTestId());

        foreach ($participant_data->getActiveIds() as $active_id) {
            if ($this->test_obj->getAnonymity()) {
                $username = $this->lng->txt('anonymous');
            } else {
                $username = $participant_data->getFormatedFullnameByActiveId($active_id);
            }

            $cgui->addItem(
                "chbUser[]",
                (string) $active_id,
                $username,
                ilUtil::getImagePath("standard/icon_usr.svg"),
                $this->lng->txt("usr")
            );
        }

        $this->main_tpl->setContent($cgui->getHTML());
    }

    private function confirmDeleteSelectedUserDataCmd(): void
    {
        $usr_ids = $this->getUserIdsFromPost();
        if ($usr_ids !== []) {
            $access_filter = $this->participant_access_filter_factory->getManageParticipantsUserFilter($this->getTestObj()->getRefId());

            $participant_data = new ilTestParticipantData($this->db, $this->lng);
            $participant_data->setParticipantAccessFilter($access_filter);
            $participant_data->setActiveIdsFilter($usr_ids);

            $participant_data->load($this->getTestObj()->getTestId());

            $this->getTestObj()->removeTestResults($participant_data);

            $this->main_tpl->setOnScreenMessage('success', $this->lng->txt("tst_selected_user_data_deleted"), true);
        }

        $this->ctrl->redirect($this, self::CMD_SHOW_PARTICIPANTS);
    }

    private function showDetailedResultsCmd(): void
    {
        $usr_ids = $this->getUserIdsFromPost();
        if ($usr_ids === []) {
            $this->main_tpl->setOnScreenMessage('info', $this->lng->txt('select_one_user'), true);
            $this->ctrl->redirect($this);
        }

        ilSession::set('show_user_results', $usr_ids);
        $results_href = $this->ctrl->getLinkTargetByClass(
            [ilTestResultsGUI::class, ilParticipantsTestResultsGUI::class, ilTestEvaluationGUI::class],
            'multiParticipantsPassDetails'
        );
        $this->ctrl->redirectToURL($results_href);
    }

    private function showUserAnswersCmd(): void
    {
        $usr_ids = $this->getUserIdsFromPost();
        if ($usr_ids !== []) {
            ilSession::set('show_user_results', $usr_ids);
        }
        $this->showUserResults(false, true);
    }

    private function showPassOverviewCmd(): void
    {
        $usr_ids = $this->getUserIdsFromPost();
        if ($usr_ids !== []) {
            ilSession::set('show_user_results', $usr_ids);
        }
        $this->showUserResults(true, false);
    }

    private function showUserResults($show_pass_details, $show_answers, $show_reached_points = false): void
    {
        $this->tabs->clearTargets();
        $this->tabs->clearSubTabs();

        $show_user_results = ilSession::get("show_user_results");

        if (!is_array($show_user_results) || count($show_user_results) === 0) {
            $this->main_tpl->setOnScreenMessage('info', $this->lng->txt("select_one_user"), true);
            $this->ctrl->redirect($this, self::CMD_SHOW_PARTICIPANTS);
        }

        $template = $this->createUserResults(
            $show_pass_details,
            $show_answers,
            $show_reached_points,
            $show_user_results
        );

        if ($template instanceof ilTemplate) {
            $this->main_tpl->setVariable("ADM_CONTENT", $template->get());
            $this->main_tpl->addCss(ilUtil::getStyleSheetLocation("output", "test_print.css", "Modules/Test"), "print");
            if ($this->getTestObj()->getShowSolutionAnswersOnly()) {
                $this->main_tpl->addCss(
                    ilUtil::getStyleSheetLocation("output", "test_print_hide_content.css", "Modules/Test"),
                    "print"
                );
            }
        }
    }

    public function createUserResults(
        bool $show_pass_details,
        bool $show_answers,
        bool $show_reached_points,
        array $show_user_results
    ): ilTemplate {
        $this->tabs->setBackTarget(
            $this->lng->txt('back'),
            $this->ctrl->getLinkTarget($this, self::CMD_SHOW_PARTICIPANTS)
        );

        if ($this->getObjectiveParent()->isObjectiveOrientedPresentationRequired()) {
            $courseLink = ilLink::_getLink($this->getObjectiveParent()->getRefId());
            $this->tabs->setBack2Target($this->lng->txt('back_to_objective_container'), $courseLink);
        }

        $template = new ilTemplate("tpl.il_as_tst_participants_result_output.html", true, true, "Modules/Test");

        $toolbar = new ilTestResultsToolbarGUI($this->ctrl, $this->main_tpl, $this->lng);

        if ($show_answers) {
            if ($this->testrequest->isset('show_best_solutions')) {
                ilSession::set('tst_results_show_best_solutions', true);
            } elseif ($this->testrequest->isset('hide_best_solutions')) {
                ilSession::set('tst_results_show_best_solutions', false);
            } elseif (ilSession::get('tst_results_show_best_solutions') !== null) {
                ilSession::set('tst_results_show_best_solutions', false);
            }

            if (ilSession::get('tst_results_show_best_solutions')) {
                $this->ctrl->setParameter($this, 'hide_best_solutions', '1');
                $toolbar->setHideBestSolutionsLinkTarget($this->ctrl->getLinkTarget($this, $this->ctrl->getCmd()));
                $this->ctrl->setParameter($this, 'hide_best_solutions', '');
            } else {
                $this->ctrl->setParameter($this, 'show_best_solutions', '1');
                $toolbar->setShowBestSolutionsLinkTarget($this->ctrl->getLinkTarget($this, $this->ctrl->getCmd()));
                $this->ctrl->setParameterByClass('', 'show_best_solutions', '');
            }
        }

        $participant_data = new ilTestParticipantData($this->db, $this->lng);
        $participant_data->setParticipantAccessFilter(
            $this->participant_access_filter_factory->getAccessResultsUserFilter($this->getTestObj()->getRefId())
        );

        $participant_data->setActiveIdsFilter($show_user_results);

        $participant_data->load($this->getTestObj()->getTestId());
        $toolbar->setParticipantSelectorOptions($participant_data->getOptionArray());

        $toolbar->build();
        $template->setVariable('RESULTS_TOOLBAR', $toolbar->getHTML());

        $service_gui = new ilTestServiceGUI($this->getTestObj());
        $service_gui->setObjectiveOrientedContainer($this->getObjectiveParent());
        $service_gui->setParticipantData($participant_data);

        $testSessionFactory = new ilTestSessionFactory($this->getTestObj(), $this->db, $this->user);

        $count = 0;
        foreach ($show_user_results as $key => $active_id) {
            if (!in_array($active_id, $participant_data->getActiveIds())) {
                continue;
            }

            $count++;
            $results = "";
            if ($active_id > 0) {
                $results = $service_gui->getResultsOfUserOutput(
                    $testSessionFactory->getSession((int) $active_id),
                    (int) $active_id,
                    ilObjTest::_getResultPass((int) $active_id),
                    $this,
                    $show_pass_details,
                    $show_answers,
                    false,
                    $show_reached_points
                );
            }
            if ($count < count($show_user_results)) {
                $template->touchBlock("break");
            }
            $template->setCurrentBlock("user_result");
            $template->setVariable("USER_RESULT", $results);
            $template->parseCurrentBlock();
        }

        return $template;
    }
}