class.ilTestParticipantsGUI.php

Go to the documentation of this file.

<?php

class ilTestParticipantsGUI
{
    public const CMD_SHOW = 'show';
    public const CMD_SET_FILTER = 'setFilter';
    public const CMD_RESET_FILTER = 'resetFilter';
    public const CMD_SAVE_CLIENT_IP = 'saveClientIp';

    public const CALLBACK_ADD_PARTICIPANT = 'addParticipants';

    protected $testObj;

    protected $questionSetConfig;

    protected $objectiveParent;

    protected $testAccess;
    private \ilGlobalTemplateInterface $main_tpl;

    public function __construct(ilObjTest $testObj, ilTestQuestionSetConfig $questionSetConfig)
    {
        global $DIC;
        $this->main_tpl = $DIC->ui()->mainTemplate();
        $this->testObj = $testObj;
        $this->questionSetConfig = $questionSetConfig;
    }

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

    public function setTestObj($testObj)
    {
        $this->testObj = $testObj;
    }

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

    public function setQuestionSetConfig($questionSetConfig)
    {
        $this->questionSetConfig = $questionSetConfig;
    }

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

    public function setObjectiveParent(ilTestObjectiveOrientedContainer $objectiveParent)
    {
        $this->objectiveParent = $objectiveParent;
    }

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

    public function setTestAccess(ilTestAccess $testAccess)
    {
        $this->testAccess = $testAccess;
    }

    public function executeCommand()
    {
        global $DIC; /* @var ILIAS\DI\Container $DIC */


        switch ($DIC->ctrl()->getNextClass($this)) {
            case 'ilrepositorysearchgui':

                require_once 'Modules/Test/classes/class.ilTestParticipantAccessFilter.php';
                require_once 'Services/Search/classes/class.ilRepositorySearchGUI.php';

                $gui = new ilRepositorySearchGUI();
                $gui->setCallback($this, self::CALLBACK_ADD_PARTICIPANT, array());

                $gui->addUserAccessFilterCallable(ilTestParticipantAccessFilter::getManageParticipantsUserFilter(
                    $this->getTestObj()->getRefId()
                ));


                $DIC->ctrl()->setReturn($this, self::CMD_SHOW);
                $DIC->ctrl()->forwardCommand($gui);

                break;

            case "iltestevaluationgui":

                require_once 'Modules/Test/classes/class.ilTestEvaluationGUI.php';

                $gui = new ilTestEvaluationGUI($this->getTestObj());
                $gui->setObjectiveOrientedContainer($this->getObjectiveParent());
                $gui->setTestAccess($this->getTestAccess());
                $DIC->tabs()->clearTargets();
                $DIC->tabs()->clearSubTabs();

                $DIC->ctrl()->forwardCommand($gui);

                break;

            default:

                $command = $DIC->ctrl()->getCmd(self::CMD_SHOW) . 'Cmd';
                $this->{$command}();
        }
    }

    public function addParticipants($a_user_ids = array()): ?bool
    {
        global $DIC; /* @var ILIAS\DI\Container $DIC */

        require_once 'Modules/Test/classes/class.ilTestParticipantAccessFilter.php';
        $filterCallback = ilTestParticipantAccessFilter::getManageParticipantsUserFilter($this->getTestObj()->getRefId());
        $a_user_ids = call_user_func_array($filterCallback, [$a_user_ids]);

        $countusers = 0;
        // add users
        if (is_array($a_user_ids)) {
            $i = 0;
            foreach ($a_user_ids as $user_id) {
                $client_ip = $_POST["client_ip"][$i] ?? '';
                $this->getTestObj()->inviteUser($user_id, $client_ip);
                $countusers++;
                $i++;
            }
        }
        $message = "";
        if ($countusers) {
            $message = $DIC->language()->txt("tst_invited_selected_users");
        }
        if (strlen($message)) {
            $this->main_tpl->setOnScreenMessage('info', $message, true);
        } else {
            $this->main_tpl->setOnScreenMessage('info', $DIC->language()->txt("tst_invited_nobody"), true);
            return false;
        }

        $DIC->ctrl()->redirect($this, self::CMD_SHOW);
        return null;
    }

    protected function buildTableGUI(): ilTestParticipantsTableGUI
    {
        global $DIC; /* @var ILIAS\DI\Container $DIC */

        require_once 'Modules/Test/classes/tables/class.ilTestParticipantsTableGUI.php';
        $tableGUI = new ilTestParticipantsTableGUI($this, self::CMD_SHOW);

        $tableGUI->setParticipantHasSolutionsFilterEnabled(
            (bool) $this->getTestObj()->getFixedParticipants()
        );

        if ($this->getTestObj()->getFixedParticipants()) {
            $tableGUI->setTitle($DIC->language()->txt('tst_tbl_invited_users'));
        } else {
            $tableGUI->setTitle($DIC->language()->txt('tst_tbl_participants'));
        }

        return $tableGUI;
    }

    protected function setFilterCmd()
    {
        $tableGUI = $this->buildTableGUI();
        $tableGUI->initFilter($this->getTestObj()->getFixedParticipants());
        $tableGUI->writeFilterToSession();
        $tableGUI->resetOffset();
        $this->showCmd();
    }

    protected function resetFilterCmd()
    {
        $tableGUI = $this->buildTableGUI();
        $tableGUI->resetFilter();
        $tableGUI->resetOffset();
        $this->showCmd();
    }

    public function showCmd()
    {
        global $DIC; /* @var ILIAS\DI\Container $DIC */

        $tableGUI = $this->buildTableGUI();

        if (!$this->getQuestionSetConfig()->areDepenciesBroken()) {
            if ($this->getTestObj()->getFixedParticipants()) {
                $participantList = $this->getTestObj()->getInvitedParticipantList()->getAccessFilteredList(
                    ilTestParticipantAccessFilter::getManageParticipantsUserFilter($this->getTestObj()->getRefId())
                );

                $tableGUI->setData($this->applyFilterCriteria($participantList->getParticipantsTableRows()));
                $tableGUI->setRowKeyDataField('usr_id');
                $tableGUI->setManageInviteesCommandsEnabled(true);
                $tableGUI->setDescription($DIC->language()->txt("fixed_participants_hint"));
            } else {
                $participantList = $this->getTestObj()->getActiveParticipantList()->getAccessFilteredList(
                    ilTestParticipantAccessFilter::getManageParticipantsUserFilter($this->getTestObj()->getRefId())
                );

                $tableGUI->setData($participantList->getParticipantsTableRows());
                $tableGUI->setRowKeyDataField('active_id');
            }

            $tableGUI->setManageResultsCommandsEnabled(true);

            $this->initToolbarControls($participantList);
        }

        $tableGUI->setAnonymity($this->getTestObj()->getAnonymity());

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

        $tableGUI->initFilter();
        $tableGUI->setFilterCommand(self::CMD_SET_FILTER);
        $tableGUI->setResetCommand(self::CMD_RESET_FILTER);

        $DIC->ui()->mainTemplate()->setContent($DIC->ctrl()->getHTML($tableGUI));
    }

    protected function applyFilterCriteria($in_rows): array
    {
        global $DIC; /* @var ILIAS\DI\Container $DIC */

        $selected_pax = ilSession::get('form_tst_participants_' . $this->getTestObj()->getRefId() . '_selection');

        if (!is_string($selected_pax)) {
            return $in_rows;
        }

        $filter = unserialize($selected_pax, ['allowed_classes' => false]);

        if (!is_string($filter) || $filter === 'all') {
            return $in_rows;
        }

        $rows = [];

        foreach ($in_rows as $row) {
            $query = $DIC->database()->query(
                'SELECT count(solution_id) count
                                FROM tst_solutions
                                WHERE active_fi = ' . $DIC->database()->quote($row['active_id'])
                . ' HAVING count ' . ($filter === 'withSolutions' ? '>' : '=') . ' 0'
            );

            if (is_array($DIC->database()->fetchAssoc($query))) {
                $rows[] = $row;
            }
        }

        return $rows;
    }

    protected function initToolbarControls(ilTestParticipantList $participantList)
    {
        global $DIC; /* @var ILIAS\DI\Container $DIC */

        if ($this->getTestObj()->getFixedParticipants()) {
            $this->addUserSearchControls($DIC->toolbar());
        }

        if ($this->getTestObj()->getFixedParticipants() && $participantList->hasUnfinishedPasses()) {
            $DIC->toolbar()->addSeparator();
        }

        if ($participantList->hasUnfinishedPasses()) {
            $this->addFinishAllPassesButton($DIC->toolbar());
        }
    }

    protected function addUserSearchControls(ilToolbarGUI $toolbar)
    {
        global $DIC; /* @var ILIAS\DI\Container $DIC */

        // search button
        include_once './Services/Search/classes/class.ilRepositorySearchGUI.php';
        ilRepositorySearchGUI::fillAutoCompleteToolbar(
            $this,
            $toolbar,
            array(
                'auto_complete_name' => $DIC->language()->txt('user'),
                'submit_name' => $DIC->language()->txt('add')
            )
        );

        require_once  'Services/UIComponent/Button/classes/class.ilLinkButton.php';
        $search_btn = ilLinkButton::getInstance();
        $search_btn->setCaption('tst_search_users');
        $search_btn->setUrl($DIC->ctrl()->getLinkTargetByClass('ilRepositorySearchGUI', 'start'));

        $toolbar->addSeparator();
        $toolbar->addButtonInstance($search_btn);
    }

    protected function addFinishAllPassesButton(ilToolbarGUI $toolbar)
    {
        global $DIC; /* @var ILIAS\DI\Container $DIC */

        $finish_all_user_passes_btn = ilLinkButton::getInstance();
        $finish_all_user_passes_btn->setCaption('finish_all_user_passes');
        $finish_all_user_passes_btn->setUrl($DIC->ctrl()->getLinkTargetByClass('iltestevaluationgui', 'finishAllUserPasses'));
        $toolbar->addButtonInstance($finish_all_user_passes_btn);
    }

    protected function saveClientIpCmd()
    {
        global $DIC; /* @var ILIAS\DI\Container $DIC */

        require_once 'Modules/Test/classes/class.ilTestParticipantAccessFilter.php';
        $filterCallback = ilTestParticipantAccessFilter::getManageParticipantsUserFilter($this->getTestObj()->getRefId());
        $a_user_ids = call_user_func_array($filterCallback, [(array) $_POST["chbUser"]]);

        if (is_array($a_user_ids)) {
            foreach ($a_user_ids as $user_id) {
                $this->getTestObj()->setClientIP($user_id, $_POST["clientip_" . $user_id]);
            }
        } else {
            $this->main_tpl->setOnScreenMessage('info', $DIC->language()->txt("select_one_user"), true);
        }
        $DIC->ctrl()->redirect($this, self::CMD_SHOW);
    }

    protected function removeParticipantsCmd()
    {
        global $DIC; /* @var ILIAS\DI\Container $DIC */

        require_once 'Modules/Test/classes/class.ilTestParticipantAccessFilter.php';
        $filterCallback = ilTestParticipantAccessFilter::getManageParticipantsUserFilter($this->getTestObj()->getRefId());
        $a_user_ids = call_user_func_array($filterCallback, [(array) $_POST["chbUser"]]);

        if (is_array($a_user_ids)) {
            foreach ($a_user_ids as $user_id) {
                $this->getTestObj()->disinviteUser($user_id);
            }
        } else {
            $this->main_tpl->setOnScreenMessage('info', $DIC->language()->txt("select_one_user"), true);
        }

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